new SonificationSpeaker(options)
The SonificationSpeaker class. This class represents an announcer using speech synthesis. It allows for scheduling speech announcements, as well as speech parameter changes - including rate, volume and pitch.
Parameters:
Name | Type | Description |
---|---|---|
options |
Highcharts.SonificationSpeakerOptionsObject | Configuration for the speaker |
Requires:
- module:modules/sonification
Try it
Requires
- module:modules/sonification
Methods
-
cancel()
-
Clear scheduled announcements, and stop current speech.
-
say(message [, options])
-
Say a message using the speaker voice. Interrupts other currently speaking announcements from this speaker.
Parameters:
Name Type Argument Description message
string The message to speak.
options
SonificationSpeakerOptionsObject <optional>
Optionally override speaker configuration.
-
sayAtTime(time, message [, options])
-
Schedule a message using the speaker voice.
Parameters:
Name Type Argument Description time
number The time offset to speak at, in milliseconds from now.
message
string The message to speak.
options
SonificationSpeakerOptionsObject <optional>
Optionally override speaker configuration.
-
setMasterVolume(vol)
-
Set speaker overall/master volume modifier. This affects all announcements, and applies in addition to the individual announcement volume.
Parameters:
Name Type Description vol
number Volume from 0 to 1.