--- title: SpeechSynthesisUtterance slug: Web/API/SpeechSynthesisUtterance tags: - API - Experimental - Interface - NeedsTranslation - Reference - SpeechSynthesisUtterance - TopicStub - Web Speech API - speech - synthesis translation_of: Web/API/SpeechSynthesisUtterance ---
{{APIRef("Web Speech API")}}{{SeeCompatTable}}
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.)
SpeechSynthesisUtterance
object instance.SpeechSynthesisUtterance
also inherits properties from its parent interface, {{domxref("EventTarget")}}.
Listen to these events using addEventListener()
or by assigning an event listener to the oneventname
property of this interface.
boundary
onboundary
property.end
onend
property.error
onerror
propertymark
onmark
property.pause
onpause
property.resume
onresume
property.start
onstart
property.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 {{domxref("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 {{domxref("Event.preventDefault","preventDefault()")}}, use the {{domxref("SpeechSynthesisUtterance.SpeechSynthesisUtterance()", "constructor")}} to create a new utterance instance containing the text from the text {{htmlelement("input")}}, set the utterance's {{domxref("SpeechSynthesisUtterance.voice","voice")}} to the voice selected in the {{htmlelement("select")}} element, and start the utterance speaking via theĀ {{domxref("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(); }
Specification | Status | Comment |
---|---|---|
{{SpecName('Web Speech API', '#tts-section', 'SpeechSynthesisUtterance')}} | {{Spec2('Web Speech API')}} |
{{Compat("api.SpeechSynthesisUtterance")}}