Soundfont

interface Soundfont extends Instrument {
uuid: string
label: string
enabled: boolean
minimized: boolean
audioUnit: InstrumentAudioUnit
icon: string
key: 'Soundfont'
file: Nullable<SoundfontFile>
presetIndex: number
remove(): void
}

Soundfont (.sf2) player

See:
- InstrumentCompositeLayer.instrument
- Instruments.Soundfont

Hierarchy

Instrument
Soundfont

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

`audioUnit: InstrumentAudioUnit`

readonly

Inherited from audioUnit

The audio unit this instrument belongs to

`icon: string`

Inherited from icon

Icon name (see IconSymbol)

`key: 'Soundfont'`

readonly

Overrides key

Always "Soundfont"

`file: Nullable<SoundfontFile>`

The soundfont file (null = none)

See:
- SoundfontFile

`presetIndex: number`

Preset index within the soundfont (0 to 65535)

Methods

`remove(): void`

Inherited from remove

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

Returns

void