SpeechSynthesisErrorEvent: SpeechSynthesisErrorEvent() constructor

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2022.

See full compatibility

The SpeechSynthesisErrorEvent() constructor creates a new SpeechSynthesisErrorEvent object.

Note: A web developer doesn't typically need to call this constructor, as the browser creates these objects itself when firing events.

Syntax

new SpeechSynthesisErrorEvent(type, options)

Parameters

type

A string with the name of the event. It is case-sensitive and browsers set it to error.

options

An object that, in addition to the properties defined in SpeechSynthesisEvent(), has the following properties:

error

A string containing the error reason. Possible values are:

canceled: A SpeechSynthesis.cancel method call caused the SpeechSynthesisUtterance to be removed from the queue before speech started.
interrupted: A SpeechSynthesis.cancel method call caused the SpeechSynthesisUtterance to be interrupted after speech had started but before it completed.
audio-busy: The operation couldn't be completed at this time because the user-agent couldn't access the audio output device (for example, the user may need to correct this by closing another application).
audio-hardware: The operation couldn't be completed at this time because the user-agent couldn't identify an audio output device (for example, the user may need to connect a speaker or configure system settings.)
network: The operation couldn't be completed at this time because some required network communication failed.
synthesis-unavailable: The operation couldn't be completed at this time because no synthesis engine was available (for example, the user may need to install or configure a synthesis engine).
synthesis-failed: The operation failed because the synthesis engine raised an error.
language-unavailable: No appropriate voice was available for the language set in SpeechSynthesisUtterance.lang. You can use the window.speechSynthesis.getVoices() method to determine which voices and languages are supported in the user's browser.
voice-unavailable: The voice set in SpeechSynthesisUtterance.voice was not available.
text-too-long: The contents of the SpeechSynthesisUtterance.text attribute was too long to synthesize.
invalid-argument: The content of the SpeechSynthesisUtterance.rate, SpeechSynthesisUtterance.pitch or SpeechSynthesisUtterance.volume property was not valid.
not-allowed: The operation's start was not allowed.

Return value

A new SpeechSynthesisErrorEvent object.

Specifications

Specification
Web Speech API # dom-speechsynthesiserrorevent-speechsynthesiserrorevent

Browser compatibility

	desktop					mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on iOS	Samsung Internet	WebView Android	WebView on iOS
`SpeechSynthesisErrorEvent()` constructor	Chrome – Full support Chrome 71 (Release date: 2018-12-04) footnote Full support	Edge – Full support Edge 79 (Release date: 2020-01-15) footnote Full support	Firefox – Full support Firefox 49 (Release date: 2016-09-20) footnote Full support	Opera – Full support Opera 58 (Release date: 2019-01-23) footnote Full support	Safari – Full support Safari 16 (Release date: 2022-09-12) footnote Full support	Chrome Android – Full support Chrome Android 71 (Release date: 2018-12-04) footnote Full support	Firefox for Android – Full support Firefox for Android 62 (Release date: 2018-09-05) footnote Full support	Opera Android – No support Opera Android footnote No support	Safari on iOS – Full support Safari on iOS 16 (Release date: 2022-09-12) footnote Full support	Samsung Internet – Full support Samsung Internet 10 (Release date: 2019-08-22) footnote Full support	WebView Android – No support WebView Android footnote No support	WebView on iOS – Full support WebView on iOS 16 (Release date: 2022-09-12) footnote Full support

Tip: you can click/tap on a cell for more information.

Full support: Full support
No support: No support