NbsSong (NoteBlockLib 3.0.0 API)

java.lang.Object
- net.raphimc.noteblocklib.model.Song
- - net.raphimc.noteblocklib.format.nbs.model.NbsSong

```
public class NbsSong
extends Song
```

Constructor Summary

Constructors
Constructor and Description

NbsSong()

NbsSong(java.lang.String fileName)

Constructors
Constructor and Description
`NbsSong()`
`NbsSong(java.lang.String fileName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NbsSong`	`copy()`
`byte`	`getAutoSaveInterval()`
`java.util.List<NbsCustomInstrument>`	`getCustomInstruments()`
`short`	`getLayerCount()`
`java.util.Map<java.lang.Integer,NbsLayer>`	`getLayers()`
`int`	`getLeftClicks()`
`short`	`getLength()`
`short`	`getLoopStartTick()`
`byte`	`getMaxLoopCount()`
`int`	`getMinutesSpent()`
`int`	`getNoteBlocksAdded()`
`int`	`getNoteBlocksRemoved()`
`int`	`getRightClicks()`
`java.lang.String`	`getSourceFileName()`
`java.lang.String`	`getSourceFileNameOr(java.lang.String fallback)`
`short`	`getTempo()`
`byte`	`getTimeSignature()`
`int`	`getVanillaInstrumentCount()`
`byte`	`getVersion()`
`boolean`	`isAutoSave()`
`boolean`	`isLoop()`
`NbsSong`	`setAutoSave(boolean autoSave)`
`NbsSong`	`setAutoSaveInterval(byte autoSaveInterval)`
`NbsSong`	`setLayerCount(short layerCount)`
`NbsSong`	`setLeftClicks(int leftClicks)`
`NbsSong`	`setLength(short length)`
`NbsSong`	`setLoop(boolean loop)`
`NbsSong`	`setLoopStartTick(short loopStartTick)`
`NbsSong`	`setMaxLoopCount(byte maxLoopCount)`
`NbsSong`	`setMinutesSpent(int minutesSpent)`
`NbsSong`	`setNoteBlocksAdded(int noteBlocksAdded)`
`NbsSong`	`setNoteBlocksRemoved(int noteBlocksRemoved)`
`NbsSong`	`setRightClicks(int rightClicks)`
`NbsSong`	`setSourceFileName(java.lang.String sourceFileName)`
`NbsSong`	`setTempo(short tempo)`
`NbsSong`	`setTimeSignature(byte timeSignature)`
`NbsSong`	`setVanillaInstrumentCount(int vanillaInstrumentCount)`
`NbsSong`	`setVersion(byte version)`

Methods inherited from class net.raphimc.noteblocklib.model.Song
copyGeneralData, getAuthor, getAuthorOr, getDescription, getDescriptionOr, getFileName, getFileNameOr, getFormat, getHumanReadableLength, getLengthInMilliseconds, getLengthInSeconds, getNotes, getOriginalAuthor, getOriginalAuthorOr, getTempoEvents, getTitle, getTitleOr, getTitleOrFileName, getTitleOrFileNameOr, millisecondsToTick, setAuthor, setDescription, setOriginalAuthor, setTitle, tickToMilliseconds

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

- Constructor Detail
  - NbsSong
```
public NbsSong()
```
  - NbsSong
```
public NbsSong(java.lang.String fileName)
```
- Method Detail
  - getLength
```
public short getLength()
```
    Returns:
    
    The length of the song, measured in ticks. Divide this by the tempo to get the length of the song in seconds. Can be -1 if the nbsVersion did not support this field
    
    Since:
    
    v0 and >= v3
  - setLength
```
public NbsSong 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.
    
    Returns:
    
    this
    
    Since:
    
    v0 and >= v3
  - getVersion
```
public byte getVersion()
```
    Returns:
    
    The version of the NBS format.
    
    Since:
    
    v0
  - setVersion
```
public NbsSong setVersion(byte version)
```
    Parameters:
    
    version - The version of the NBS format.
    
    Returns:
    
    this
    
    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 NbsSong 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.
    
    Returns:
    
    this
    
    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 NbsSong 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.
    
    Returns:
    
    this
    
    Since:
    
    v0
  - getTempo
```
public short getTempo()
```
    Returns:
    
    The tempo of the song multiplied by 100 (for example, 1225 instead of 12.25). Measured in ticks per second.
    
    Since:
    
    v0
  - setTempo
```
public NbsSong setTempo(short tempo)
```
    Parameters:
    
    tempo - The tempo of the song multiplied by 100 (for example, 1225 instead of 12.25). Measured in ticks per second.
    
    Returns:
    
    this
    
    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 NbsSong 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.
    
    Returns:
    
    this
    
    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 NbsSong 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.
    
    Returns:
    
    this
    
    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 NbsSong 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.
    
    Returns:
    
    this
    
    Since:
    
    v0
  - getMinutesSpent
```
public int getMinutesSpent()
```
    Returns:
    
    Amount of minutes spent on the project.
    
    Since:
    
    v0
  - setMinutesSpent
```
public NbsSong setMinutesSpent(int minutesSpent)
```
    Parameters:
    
    minutesSpent - Amount of minutes spent on the project.
    
    Returns:
    
    this
    
    Since:
    
    v0
  - getLeftClicks
```
public int getLeftClicks()
```
    Returns:
    
    Amount of times the user has left-clicked.
    
    Since:
    
    v0
  - setLeftClicks
```
public NbsSong setLeftClicks(int leftClicks)
```
    Parameters:
    
    leftClicks - Amount of times the user has left-clicked.
    
    Returns:
    
    this
    
    Since:
    
    v0
  - getRightClicks
```
public int getRightClicks()
```
    Returns:
    
    Amount of times the user has right-clicked.
    
    Since:
    
    v0
  - setRightClicks
```
public NbsSong setRightClicks(int rightClicks)
```
    Parameters:
    
    rightClicks - Amount of times the user has right-clicked.
    
    Returns:
    
    this
    
    Since:
    
    v0
  - getNoteBlocksAdded
```
public int getNoteBlocksAdded()
```
    Returns:
    
    Amount of times the user has added a note block.
    
    Since:
    
    v0
  - setNoteBlocksAdded
```
public NbsSong setNoteBlocksAdded(int noteBlocksAdded)
```
    Parameters:
    
    noteBlocksAdded - Amount of times the user has added a note block.
    
    Returns:
    
    this
    
    Since:
    
    v0
  - getNoteBlocksRemoved
```
public int getNoteBlocksRemoved()
```
    Returns:
    
    Amount of times the user has removed a note block.
    
    Since:
    
    v0
  - setNoteBlocksRemoved
```
public NbsSong setNoteBlocksRemoved(int noteBlocksRemoved)
```
    Parameters:
    
    noteBlocksRemoved - Amount of times the user has removed a note block.
    
    Returns:
    
    this
    
    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
  - getSourceFileNameOr
```
public java.lang.String getSourceFileNameOr(java.lang.String fallback)
```
    Parameters:
    
    fallback - The fallback value if the source file name is not set.
    
    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 NbsSong 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).
    
    Returns:
    
    this
    
    Since:
    
    v0
  - isLoop
```
public boolean isLoop()
```
    Returns:
    
    Whether looping is on or off.
    
    Since:
    
    v4
  - setLoop
```
public NbsSong setLoop(boolean loop)
```
    Parameters:
    
    loop - Whether looping is on or off.
    
    Returns:
    
    this
    
    Since:
    
    v4
  - getMaxLoopCount
```
public byte getMaxLoopCount()
```
    Returns:
    
    0 = infinite. Other values mean the amount of times the song loops.
    
    Since:
    
    v4
  - setMaxLoopCount
```
public NbsSong setMaxLoopCount(byte maxLoopCount)
```
    Parameters:
    
    maxLoopCount - 0 = infinite. Other values mean the amount of times the song loops.
    
    Returns:
    
    this
    
    Since:
    
    v4
  - getLoopStartTick
```
public short getLoopStartTick()
```
    Returns:
    
    Determines which part of the song (in ticks) it loops back to.
    
    Since:
    
    v4
  - setLoopStartTick
```
public NbsSong setLoopStartTick(short loopStartTick)
```
    Parameters:
    
    loopStartTick - Determines which part of the song (in ticks) it loops back to.
    
    Returns:
    
    this
    
    Since:
    
    v4
  - getLayers
```
public java.util.Map<java.lang.Integer,NbsLayer> getLayers()
```
    Returns:
    
    The layers of this song
    
    Since:
    
    v0
  - getCustomInstruments
```
public java.util.List<NbsCustomInstrument> getCustomInstruments()
```
    Returns:
    
    The custom instruments of this song
    
    Since:
    
    v0
  - copy
```
public NbsSong copy()
```
    Specified by:
    
    copy in class Song

Class NbsSong

Constructor Summary

Method Summary

Methods inherited from class net.raphimc.noteblocklib.model.Song

Methods inherited from class java.lang.Object

Constructor Detail

NbsSong

NbsSong

Method Detail

getLength

setLength

getVersion

setVersion

getVanillaInstrumentCount

setVanillaInstrumentCount

getLayerCount

setLayerCount

getTempo

setTempo

isAutoSave

setAutoSave

getAutoSaveInterval

setAutoSaveInterval

getTimeSignature

setTimeSignature

getMinutesSpent

setMinutesSpent

getLeftClicks

setLeftClicks

getRightClicks

setRightClicks

getNoteBlocksAdded

setNoteBlocksAdded

getNoteBlocksRemoved

setNoteBlocksRemoved

getSourceFileName

getSourceFileNameOr

setSourceFileName

isLoop

setLoop

getMaxLoopCount

setMaxLoopCount

getLoopStartTick

setLoopStartTick

getLayers

getCustomInstruments

copy