W3cubDocs

/DOM

SpeechSynthesisEvent

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 milliseconds 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 occuring 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 + ' milliseconds.');
}

Specifications

Browser compatibilityUpdate compatibility data on GitHub

Desktop
Chrome Edge Firefox Internet Explorer Opera Safari
Basic support 33 Yes 49 No 21 7
charIndex 33 Yes 49 No 21 7
elapsedTime 33 Yes 49 No 21 7
name 33 Yes 49 No 21 7
utterance 33 Yes 49 No 21 7
Mobile
Android webview Chrome for Android Edge Mobile Firefox for Android Opera for Android iOS Safari Samsung Internet
Basic support 4.4.3 33 Yes 62
62
61 — 62
Disabled
Disabled From version 61 until version 62 (exclusive): this feature is behind the media.webspeech.synth.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
No 7.1 ?
charIndex 4.4.3 33 Yes 62
62
61 — 62
Disabled
Disabled From version 61 until version 62 (exclusive): this feature is behind the media.webspeech.synth.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
No 7.1 ?
elapsedTime 4.4.3 33 Yes 62
62
61 — 62
Disabled
Disabled From version 61 until version 62 (exclusive): this feature is behind the media.webspeech.synth.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
No 7.1 ?
name 4.4.3 33 Yes 62
62
61 — 62
Disabled
Disabled From version 61 until version 62 (exclusive): this feature is behind the media.webspeech.synth.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
No 7.1 ?
utterance 4.4.3 33 Yes 62
62
61 — 62
Disabled
Disabled From version 61 until version 62 (exclusive): this feature is behind the media.webspeech.synth.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
No 7.1 ?

See also

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisEvent