Options for an Earcon.
Requires
- module:modules/sonification
Members
-
id :string|undefined
-
The unique ID of the Earcon. Generated if not supplied.
Type:
- string | undefined
-
instruments :Array.<Highcharts.EarconInstrument>
-
The instruments and their options defining this earcon.
Type:
- Array.<Highcharts.EarconInstrument>
-
onEnd :function|undefined
-
Callback function to call when earcon has finished playing.
Type:
- function | undefined
-
pan :number|undefined
-
Global panning of all instruments. Overrides all panning on individual instruments. Can be a number between -1 and 1.
Type:
- number | undefined
-
volume :number|undefined
-
Master volume for all instruments. Volume settings on individual instruments can still be used for relative volume between the instruments. This setting does not affect volumes set by functions in individual instruments. Can be a number between 0 and 1. Defaults to 1.
Type:
- number | undefined