A set of options for the Instrument class.
Requires
- module:modules/sonification
Members
-
allowedFrequencies :Array.<number>|undefined
-
A list of allowed frequencies for this instrument. If trying to play a frequency not on this list, the closest frequency will be used. Set to
null
to allow all frequencies to be used. Defaults tonull
.Type:
- Array.<number> | undefined
-
id :string|undefined
-
The unique ID of the instrument. Generated if not supplied.
Type:
- string | undefined
-
oscillator :Highcharts.OscillatorOptionsObject|undefined
-
Options specific to oscillator instruments.
Type:
- Highcharts.OscillatorOptionsObject | undefined
-
playCallbackInterval :number|undefined
-
When using functions to determine frequency or other parameters during playback, this options specifies how often to call the callback functions. Number given in milliseconds. Defaults to 20.
Type:
- number | undefined
-
type :string|undefined
-
The type of instrument. Currently only
oscillator
is supported. Defaults tooscillator
.Type:
- string | undefined