The error
event of the Web Speech API SpeechSynthesisUtterance
object is fired when an error occurs that prevents the utterance from being successfully spoken.
On this page
SpeechSynthesisUtterance: error event
Syntax
Use the event name in methods like addEventListener()
, or set an event handler property.
js
addEventListener("error", (event) => {});
onerror = (event) => {};
Event type
A SpeechSynthesisErrorEvent
. Inherits from SpeechSynthesisEvent
and Event
.
Event properties
In addition to the properties listed below, properties from the parent interface, Event
, are available.
charIndex
Read only-
Returns the index position of the character in the
SpeechSynthesisUtterance.text
that was being spoken when the event was triggered. elapsedTime
Read only-
Returns the elapsed time in seconds after the
SpeechSynthesisUtterance.text
started being spoken that the event was triggered at. error
Read only-
Returns an error code indicating what has gone wrong with a speech synthesis attempt.
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 amark
event, or the type of boundary reached in the case of aboundary
event. utterance
Read only-
Returns the
SpeechSynthesisUtterance
instance that the event was triggered on.
Examples
You can use the error
event in an addEventListener
method:
js
utterThis.addEventListener("error", (event) => {
console.log(
`An error has occurred with the speech synthesis: ${event.error}`,
);
});
Or use the onerror
event handler property:
js
utterThis.onerror = (event) => {
console.log(
`An error has occurred with the speech synthesis: ${event.error}`,
);
};
Specifications
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
error_event |
33 | 14 | 49 | No | 21 | 7 | No | 33 | 62 | No | 7 | 3.0 |
See also
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisUtterance/error_event