The error
property of the SpeechSynthesisErrorEvent
interface returns an error code indicating what has gone wrong with a speech synthesis attempt.
SpeechSynthesisErrorEvent.error
Value
A DOMString
containing an error code. Possible codes are:
-
canceled
-
A
SpeechSynthesis.cancel
method call caused theSpeechSynthesisUtterance
to be removed from the queue before it had begun being spoken. -
interrupted
-
A
SpeechSynthesis.cancel
method call caused theSpeechSynthesisUtterance
to be interrupted after it had begun being spoken and 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.
-
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.
-
No appropriate voice was available for the language set in
SpeechSynthesisUtterance.lang
. -
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
orSpeechSynthesisUtterance.volume
property was not valid.
Examples
var synth = window.speechSynthesis; var inputForm = document.querySelector('form'); var inputTxt = document.querySelector('input'); var voiceSelect = document.querySelector('select'); var voices = synth.getVoices(); ... inputForm.onsubmit = function(event) { event.preventDefault(); var utterThis = new SpeechSynthesisUtterance(inputTxt.value); var selectedOption = voiceSelect.selectedOptions[0].getAttribute('data-name'); for(i = 0; i < voices.length ; i++) { if(voices[i].name === selectedOption) { utterThis.voice = voices[i]; } } synth.speak(utterThis); utterThis.onerror = function(event) { console.error('An error has occurred with the speech synthesis: ' + event.error); } inputTxt.blur(); }
Specifications
Specification |
---|
Web Speech API # dom-speechsynthesiserrorevent-error |
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 |
33
|
≤18
|
49
|
No
|
21
|
7
|
No
|
33
|
62
|
No
|
7
|
3.0
|
See also
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisErrorEvent/error