Instrument

interface Instrument extends Device {
uuid: string
label: string
enabled: boolean
minimized: boolean
key: keyof Instruments
audioUnit: InstrumentAudioUnit
icon: string
remove(): void
}

The sound source of an instrument unit

Hierarchy

Device
Instrument

Properties

`uuid: string`

readonly

Inherited from uuid

Unique id

`label: string`

Inherited from label

Custom label

`enabled: boolean`

Inherited from enabled

Enable or bypass the device

`minimized: boolean`

Inherited from minimized

Collapse the device editor in the studio

`key: keyof Instruments`

readonly

Instrument type identifier

See:
- Instruments

`audioUnit: InstrumentAudioUnit`

readonly

The audio unit this instrument belongs to

See:
- InstrumentAudioUnit

`icon: string`

Icon name (see IconSymbol)

Methods

`remove(): void`

Overrides remove

Removes the whole audio unit. Use InstrumentAudioUnit.setInstrument to swap the instrument. An instrument inside an InstrumentCompositeLayer removes that layer instead

Returns

void