NbsHeader (NoteBlockLib 2.1.0 API)

java.lang.Object
- net.raphimc.noteblocklib.format.nbs.model.NbsHeader

All Implemented Interfaces:: Header

public class NbsHeader
extends java.lang.Object
implements Header

Constructor Summary

Constructors
Constructor and Description
`NbsHeader()`
`NbsHeader(com.google.common.io.LittleEndianDataInputStream dis)`
`NbsHeader(short length, byte version, int vanillaInstrumentCount, short layerCount, java.lang.String title, java.lang.String author, java.lang.String originalAuthor, java.lang.String description, short speed, boolean autoSave, byte autoSaveInterval, byte timeSignature, int minutesSpent, int leftClicks, int rightClicks, int noteBlocksAdded, int noteBlocksRemoved, java.lang.String sourceFileName)`
`NbsHeader(short length, byte version, int vanillaInstrumentCount, short layerCount, java.lang.String title, java.lang.String author, java.lang.String originalAuthor, java.lang.String description, short speed, boolean autoSave, byte autoSaveInterval, byte timeSignature, int minutesSpent, int leftClicks, int rightClicks, int noteBlocksAdded, int noteBlocksRemoved, java.lang.String sourceFileName, boolean loop, byte maxLoopCount, short loopStartTick)`
`NbsHeader(SongView<N> songView)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAuthor()`
`byte`	`getAutoSaveInterval()`
`java.lang.String`	`getDescription()`
`short`	`getLayerCount()`
`int`	`getLeftClicks()`
`short`	`getLength()` Can be -1 if the nbsVersion did not support this field
`short`	`getLoopStartTick()`
`byte`	`getMaxLoopCount()`
`int`	`getMinutesSpent()`
`byte`	`getNbsVersion()` Deprecated.
`int`	`getNoteBlocksAdded()`
`int`	`getNoteBlocksRemoved()`
`java.lang.String`	`getOriginalAuthor()`
`int`	`getRightClicks()`
`java.lang.String`	`getSourceFileName()`
`short`	`getSpeed()`
`byte`	`getTimeSignature()`
`java.lang.String`	`getTitle()`
`int`	`getVanillaInstrumentCount()`
`byte`	`getVersion()`
`boolean`	`isAutoSave()`
`boolean`	`isLoop()`
`void`	`setAuthor(java.lang.String author)`
`void`	`setAutoSave(boolean autoSave)`
`void`	`setAutoSaveInterval(byte autoSaveInterval)`
`void`	`setDescription(java.lang.String description)`
`void`	`setLayerCount(short layerCount)`
`void`	`setLeftClicks(int leftClicks)`
`void`	`setLength(short length)`
`void`	`setLoop(boolean loop)`
`void`	`setLoopStartTick(short loopStartTick)`
`void`	`setMaxLoopCount(byte maxLoopCount)`
`void`	`setMinutesSpent(int minutesSpent)`
`void`	`setNbsVersion(byte version)` Deprecated.
`void`	`setNoteBlocksAdded(int noteBlocksAdded)`
`void`	`setNoteBlocksRemoved(int noteBlocksRemoved)`
`void`	`setOriginalAuthor(java.lang.String originalAuthor)`
`void`	`setRightClicks(int rightClicks)`
`void`	`setSourceFileName(java.lang.String sourceFileName)`
`void`	`setSpeed(short speed)`
`void`	`setTimeSignature(byte timeSignature)`
`void`	`setTitle(java.lang.String title)`
`void`	`setVanillaInstrumentCount(int vanillaInstrumentCount)`
`void`	`setVersion(byte version)`
`void`	`write(com.google.common.io.LittleEndianDataOutputStream dos)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NbsHeader
```
public NbsHeader(com.google.common.io.LittleEndianDataInputStream dis)
          throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - NbsHeader
```
public NbsHeader(short length,
                 byte version,
                 int vanillaInstrumentCount,
                 short layerCount,
                 java.lang.String title,
                 java.lang.String author,
                 java.lang.String originalAuthor,
                 java.lang.String description,
                 short speed,
                 boolean autoSave,
                 byte autoSaveInterval,
                 byte timeSignature,
                 int minutesSpent,
                 int leftClicks,
                 int rightClicks,
                 int noteBlocksAdded,
                 int noteBlocksRemoved,
                 java.lang.String sourceFileName,
                 boolean loop,
                 byte maxLoopCount,
                 short loopStartTick)
```
  - NbsHeader
```
public NbsHeader(short length,
                 byte version,
                 int vanillaInstrumentCount,
                 short layerCount,
                 java.lang.String title,
                 java.lang.String author,
                 java.lang.String originalAuthor,
                 java.lang.String description,
                 short speed,
                 boolean autoSave,
                 byte autoSaveInterval,
                 byte timeSignature,
                 int minutesSpent,
                 int leftClicks,
                 int rightClicks,
                 int noteBlocksAdded,
                 int noteBlocksRemoved,
                 java.lang.String sourceFileName)
```
  - NbsHeader
```
public NbsHeader()
```
  - NbsHeader
```
public NbsHeader(SongView<N> songView)
```
- Method Detail
  - write
```
public void write(com.google.common.io.LittleEndianDataOutputStream dos)
           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getLength
```
public short getLength()
```
    Can be -1 if the nbsVersion did not support this field
    
    Returns:
    
    The length of the song, measured in ticks. Divide this by the tempo to get the length of the song in seconds.
    
    Since:
    
    v0 and >= v3
  - setLength
```
public void setLength(short length)
```
    Parameters:
    
    length - The length of the song, measured in ticks. Divide this by the tempo to get the length of the song in seconds.
    
    Since:
    
    v0 and >= v3
  - getVersion
```
public byte getVersion()
```
    Returns:
    
    The version of the NBS format.
    
    Since:
    
    v0
  - setVersion
```
public void setVersion(byte version)
```
    Parameters:
    
    version - The version of the NBS format.
    
    Since:
    
    v0
  - getNbsVersion
```
@Deprecated
public byte getNbsVersion()
```
    Deprecated.
    
    Returns:
    
    The version of the NBS format.
    
    Since:
    
    v0
  - setNbsVersion
```
@Deprecated
public void setNbsVersion(byte version)
```
    Deprecated.
    
    Parameters:
    
    version - The version of the NBS format.
    
    Since:
    
    v0
  - getVanillaInstrumentCount
```
public int getVanillaInstrumentCount()
```
    Returns:
    
    Amount of default instruments when the song was saved. This is needed to determine at what index custom instruments start.
    
    Since:
    
    v0
  - setVanillaInstrumentCount
```
public void setVanillaInstrumentCount(int vanillaInstrumentCount)
```
    Parameters:
    
    vanillaInstrumentCount - Amount of default instruments when the song was saved. This is needed to determine at what index custom instruments start.
    
    Since:
    
    v0
  - getLayerCount
```
public short getLayerCount()
```
    Returns:
    
    The last layer with at least one note block in it, or the last layer that has had its name, volume or stereo changed.
    
    Since:
    
    v0
  - setLayerCount
```
public void setLayerCount(short layerCount)
```
    Parameters:
    
    layerCount - The last layer with at least one note block in it, or the last layer that has had its name, volume or stereo changed.
    
    Since:
    
    v0
  - getTitle
```
public java.lang.String getTitle()
```
    Returns:
    
    The name of the song.
    
    Since:
    
    v0
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Parameters:
    
    title - The name of the song.
    
    Since:
    
    v0
  - getAuthor
```
public java.lang.String getAuthor()
```
    Returns:
    
    The author of the song.
    
    Since:
    
    v0
  - setAuthor
```
public void setAuthor(java.lang.String author)
```
    Parameters:
    
    author - The author of the song.
    
    Since:
    
    v0
  - getOriginalAuthor
```
public java.lang.String getOriginalAuthor()
```
    Returns:
    
    The original author of the song.
    
    Since:
    
    v0
  - setOriginalAuthor
```
public void setOriginalAuthor(java.lang.String originalAuthor)
```
    Parameters:
    
    originalAuthor - The original author of the song.
    
    Since:
    
    v0
  - getDescription
```
public java.lang.String getDescription()
```
    Returns:
    
    The description of the song.
    
    Since:
    
    v0
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Parameters:
    
    description - The description of the song.
    
    Since:
    
    v0
  - getSpeed
```
public short getSpeed()
```
    Returns:
    
    The tempo of the song multiplied by 100 (for example, 1225 instead of 12.25). Measured in ticks per second.
    
    Since:
    
    v0
  - setSpeed
```
public void setSpeed(short speed)
```
    Parameters:
    
    speed - The tempo of the song multiplied by 100 (for example, 1225 instead of 12.25). Measured in ticks per second.
    
    Since:
    
    v0
  - isAutoSave
```
public boolean isAutoSave()
```
    Returns:
    
    Whether auto-saving has been enabled (0 or 1). As of NBS version 4 this value is still saved to the file, but no longer used in the program.
    
    Since:
    
    v0
  - setAutoSave
```
public void setAutoSave(boolean autoSave)
```
    Parameters:
    
    autoSave - Whether auto-saving has been enabled (0 or 1). As of NBS version 4 this value is still saved to the file, but no longer used in the program.
    
    Since:
    
    v0
  - getAutoSaveInterval
```
public byte getAutoSaveInterval()
```
    Returns:
    
    The amount of minutes between each auto-save (if it has been enabled) (1-60). As of NBS version 4 this value is still saved to the file, but no longer used in the program.
    
    Since:
    
    v0
  - setAutoSaveInterval
```
public void setAutoSaveInterval(byte autoSaveInterval)
```
    Parameters:
    
    autoSaveInterval - The amount of minutes between each auto-save (if it has been enabled) (1-60). As of NBS version 4 this value is still saved to the file, but no longer used in the program.
    
    Since:
    
    v0
  - getTimeSignature
```
public byte getTimeSignature()
```
    Returns:
    
    The time signature of the song. If this is 3, then the signature is 3/4. Default is 4. This value ranges from 2-8.
    
    Since:
    
    v0
  - setTimeSignature
```
public void setTimeSignature(byte timeSignature)
```
    Parameters:
    
    timeSignature - The time signature of the song. If this is 3, then the signature is 3/4. Default is 4. This value ranges from 2-8.
    
    Since:
    
    v0
  - getMinutesSpent
```
public int getMinutesSpent()
```
    Returns:
    
    Amount of minutes spent on the project.
    
    Since:
    
    v0
  - setMinutesSpent
```
public void setMinutesSpent(int minutesSpent)
```
    Parameters:
    
    minutesSpent - Amount of minutes spent on the project.
    
    Since:
    
    v0
  - getLeftClicks
```
public int getLeftClicks()
```
    Returns:
    
    Amount of times the user has left-clicked.
    
    Since:
    
    v0
  - setLeftClicks
```
public void setLeftClicks(int leftClicks)
```
    Parameters:
    
    leftClicks - Amount of times the user has left-clicked.
    
    Since:
    
    v0
  - getRightClicks
```
public int getRightClicks()
```
    Returns:
    
    Amount of times the user has right-clicked.
    
    Since:
    
    v0
  - setRightClicks
```
public void setRightClicks(int rightClicks)
```
    Parameters:
    
    rightClicks - Amount of times the user has right-clicked.
    
    Since:
    
    v0
  - getNoteBlocksAdded
```
public int getNoteBlocksAdded()
```
    Returns:
    
    Amount of times the user has added a note block.
    
    Since:
    
    v0
  - setNoteBlocksAdded
```
public void setNoteBlocksAdded(int noteBlocksAdded)
```
    Parameters:
    
    noteBlocksAdded - Amount of times the user has added a note block.
    
    Since:
    
    v0
  - getNoteBlocksRemoved
```
public int getNoteBlocksRemoved()
```
    Returns:
    
    Amount of times the user has removed a note block.
    
    Since:
    
    v0
  - setNoteBlocksRemoved
```
public void setNoteBlocksRemoved(int noteBlocksRemoved)
```
    Parameters:
    
    noteBlocksRemoved - Amount of times the user has removed a note block.
    
    Since:
    
    v0
  - getSourceFileName
```
public java.lang.String getSourceFileName()
```
    Returns:
    
    If the song has been imported from a .mid or .schematic file, that file name is stored here (only the name of the file, not the path).
    
    Since:
    
    v0
  - setSourceFileName
```
public void setSourceFileName(java.lang.String sourceFileName)
```
    Parameters:
    
    sourceFileName - If the song has been imported from a .mid or .schematic file, that file name is stored here (only the name of the file, not the path).
    
    Since:
    
    v0
  - isLoop
```
public boolean isLoop()
```
    Returns:
    
    Whether looping is on or off.
    
    Since:
    
    v4
  - setLoop
```
public void setLoop(boolean loop)
```
    Parameters:
    
    loop - Whether looping is on or off.
    
    Since:
    
    v4
  - getMaxLoopCount
```
public byte getMaxLoopCount()
```
    Returns:
    
    0 = infinite. Other values mean the amount of times the song loops.
    
    Since:
    
    v4
  - setMaxLoopCount
```
public void setMaxLoopCount(byte maxLoopCount)
```
    Parameters:
    
    maxLoopCount - 0 = infinite. Other values mean the amount of times the song loops.
    
    Since:
    
    v4
  - getLoopStartTick
```
public short getLoopStartTick()
```
    Returns:
    
    Determines which part of the song (in ticks) it loops back to.
    
    Since:
    
    v4
  - setLoopStartTick
```
public void setLoopStartTick(short loopStartTick)
```
    Parameters:
    
    loopStartTick - Determines which part of the song (in ticks) it loops back to.
    
    Since:
    
    v4

Class NbsHeader

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NbsHeader

NbsHeader

NbsHeader

NbsHeader

NbsHeader

Method Detail

write

getLength

setLength

getVersion

setVersion

getNbsVersion

setNbsVersion

getVanillaInstrumentCount

setVanillaInstrumentCount

getLayerCount

setLayerCount

getTitle

setTitle

getAuthor

setAuthor

getOriginalAuthor

setOriginalAuthor

getDescription

setDescription

getSpeed

setSpeed

isAutoSave

setAutoSave

getAutoSaveInterval

setAutoSaveInterval

getTimeSignature

setTimeSignature

getMinutesSpent

setMinutesSpent

getLeftClicks

setLeftClicks

getRightClicks

setRightClicks

getNoteBlocksAdded

setNoteBlocksAdded

getNoteBlocksRemoved

setNoteBlocksRemoved

getSourceFileName

setSourceFileName

isLoop

setLoop

getMaxLoopCount

setMaxLoopCount

getLoopStartTick

setLoopStartTick