Apparat
interface Apparat extends Instrument, ScriptDevice {
uuid: string
label: string
enabled: boolean
minimized: boolean
code: string
parameters: readonly ScriptParameter[]
samples: readonly ScriptSample[]
audioUnit: InstrumentAudioUnit
icon: string
key: 'Apparat'
parameter(label: string): ScriptParameter
sample(label: string): ScriptSample
remove(): void
}Scriptable instrument. See ScriptDevice
Hierarchy
Properties
uuid: string
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
code: string
Inherited from code
The script source. Setting it re-declares the parameters and samples from its // @param / // @sample lines
parameters: readonly ScriptParameter[]
Inherited from parameters
Declared parameters
samples: readonly ScriptSample[]
Inherited from samples
Declared sample slots
audioUnit: InstrumentAudioUnit
Inherited from audioUnit
The audio unit this instrument belongs to
icon: string
Inherited from icon
Icon name (see IconSymbol)
key: 'Apparat'
Overrides key
Always "Apparat"
Methods
parameter(label: string): ScriptParameter
Inherited from parameter
Find a parameter by its declared name
Parameters
label(string)
Returns
sample(label: string): ScriptSample
Inherited from sample
Find a sample slot by its declared name
Parameters
label(string)
Returns
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