SpeechSynthesisEvent

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The SpeechSynthesisEvent interface of the Web Speech API contains information about the current state of SpeechSynthesisUtterance objects that have been processed in the speech service.

Properties

The SpeechSynthesisEvent interface also inherits properties from its parent interface, Event.

SpeechSynthesisEvent.charIndex Read only

Returns the index position of the character in the SpeechSynthesisUtterance.text that was being spoken when the event was triggered.

SpeechSynthesisEvent.elapsedTime Read only

Returns the elapsed time in seconds after the SpeechSynthesisUtterance.text started being spoken that the event was triggered at.

SpeechSynthesisEvent.name Read only

Returns the name associated with certain types of events occurring as the SpeechSynthesisUtterance.text is being spoken: the name of the SSML marker reached in the case of a mark event, or the type of boundary reached in the case of a boundary event.

SpeechSynthesisEvent.utterance Read only

Returns the SpeechSynthesisUtterance instance that the event was triggered on.

Methods

The SpeechSynthesisEvent interface also inherits methods from its parent interface, Event.

Examples

utterThis.onpause = function(event) {
  var char = event.utterance.text.charAt(event.charIndex);
  console.log('Speech paused at character ' + event.charIndex + ' of "' +
  event.utterance.text + '", which is "' + char + '".');
}

utterThis.onboundary = function(event) {
  console.log(event.name + ' boundary reached after ' + event.elapsedTime + ' seconds.');
}

Specifications

Specification
Web Speech API
# speechsynthesisevent

Browser compatibility

BCD tables only load in the browser

See also