Class SongInstruments

Readonlyall

Readonly InternalfirstCustomIndex

[iterator]

• "[iterator]"(): Iterator<[number, Instrument]>

  Iterate each id-instrument pair.

  Returns Iterator<[number, Instrument]>

  Example

  This is intended for use in for loops.

  for (const [id, instrument] in song.instruments) { ... }
  Copy

add

• add(instrument: Instrument): Instrument

  Add an existing Instrument.

  Parameters

  • instrument: Instrument

    Instrument to add

  Returns Instrument

create

• create(options: InstrumentOptions): Instrument

  Create and add an Instrument.

  Parameters

  • options: InstrumentOptions

    Options for the instrument

  Returns Instrument

delete

• delete(id: number): void

  Delete an Instrument.

  Parameters

  • id: number

    ID of the instrument to be deleted

  Returns void

  Remarks

  Does not protect built-in instruments. This may not be desirable!

  See

  According to the NBS specification, instrument IDs must be consecutive! Make sure to update any proceeding instrument IDs.

getTotal

• getTotal(): number

  Total number of instruments.

  Returns number

set

• set(id: number, instrument: Instrument): Instrument

  Set an existing Instrument at an ID.

  Parameters

  • id: number

    ID of the instrument to be set

  • instrument: Instrument

    The instrument to set at id.

  Returns Instrument

  Remarks

  Any existing instrument with the same ID as the added instrument will be overwritten. This includes built-in instruments, which may not be desirable!

  See

  According to the NBS specification, instrument IDs must be consecutive!

constructor

• new SongInstruments(): SongInstruments

  Returns SongInstruments