This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The SpeechSynthesisUtterance
interface of the Web Speech API represents a speech request. It contains the content the speech service should read and information about how to read it (e.g. language, pitch and volume.)
Constructor
SpeechSynthesisUtterance.SpeechSynthesisUtterance()
- Returns a new
SpeechSynthesisUtterance
object instance.
Properties
SpeechSynthesisUtterance
also inherits properties from its parent interface, EventTarget
.
SpeechSynthesisUtterance.lang
- Gets and sets the language of the utterance.
SpeechSynthesisUtterance.pitch
- Gets and sets the pitch at which the utterance will be spoken at.
SpeechSynthesisUtterance.rate
- Gets and sets the speed at which the utterance will be spoken at.
SpeechSynthesisUtterance.text
- Gets and sets the text that will be synthesised when the utterance is spoken.
SpeechSynthesisUtterance.voice
- Gets and sets the voice that will be used to speak the utterance.
SpeechSynthesisUtterance.volume
- Gets and sets the volume that the utterance will be spoken at.
Events
Listen to these events using addEventListener()
or by assigning an event listener to the oneventname
property of this interface.
boundary
- Fired when the spoken utterance reaches a word or sentence boundary.
Also available via theonboundary
property. end
- Fired when the utterance has finished being spoken.
Also available via theonend
property. error
- Fired when an error occurs that prevents the utterance from being succesfully spoken.
Also available via theonerror
property mark
- Fired when the spoken utterance reaches a named SSML "mark" tag.
Also available via theonmark
property. pause
- Fired when the utterance is paused part way through.
Also available via theonpause
property. resume
- Fired when a paused utterance is resumed.
Also available via theonresume
property. start
- Fired when the utterance has begun to be spoken.
Also available via theonstart
property.
Examples
In our basic Speech synthesiser demo (source), we first grab a reference to the SpeechSynthesis controller using window.speechSynthesis
. After defining some necessary variables, we retrieve a list of the voices available using SpeechSynthesis.getVoices()
and populate a select menu with them so the user can choose what voice they want.
Inside the inputForm.onsubmit
handler, we stop the form submitting with preventDefault()
, use the constructor
to create a new utterance instance containing the text from the text <input>
, set the utterance's voice
to the voice selected in the <select>
element, and start the utterance speaking via the SpeechSynthesis.speak()
method.
var synth = window.speechSynthesis; var voices = synth.getVoices(); var inputForm = document.querySelector('form'); var inputTxt = document.querySelector('input'); var voiceSelect = document.querySelector('select'); for(var i = 0; i < voices.length; i++) { var option = document.createElement('option'); option.textContent = voices[i].name + ' (' + voices[i].lang + ')'; option.value = i; voiceSelect.appendChild(option); } inputForm.onsubmit = function(event) { event.preventDefault(); var utterThis = new SpeechSynthesisUtterance(inputTxt.value); utterThis.voice = voices[voiceSelect.value]; synth.speak(utterThis); inputTxt.blur(); }
Specifications
Specification | Status | Comment |
---|---|---|
Web Speech API The definition of 'SpeechSynthesisUtterance' in that specification. |
Draft |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
SpeechSynthesisUtterance | Chrome Full support 33 | Edge Full support ≤18 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
SpeechSynthesisUtterance() constructor | Chrome Full support 33 | Edge Full support ≤18 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
boundary event | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
end event | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
error event | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
lang | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
mark event | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
onboundary | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
onend | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
onerror | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
onmark | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
onpause | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
onresume | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
onstart | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
pause event | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
pitch | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
rate | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
resume event | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
start event | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
text | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
voice | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
volume | Chrome Full support 33 | Edge Full support 14 | Firefox Full support 49 | IE No support No | Opera Full support 21 | Safari Full support 7 | WebView Android No support No | Chrome Android Full support 33 | Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support 7 | Samsung Internet Android Full support 3.0 |
Legend
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.
- User must explicitly enable this feature.
- User must explicitly enable this feature.