SpeechSynthesisUtterance

{{APIRef("Web Speech API")}}

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.)

{{InheritanceDiagram}}

Constructor

• {{domxref("SpeechSynthesisUtterance.SpeechSynthesisUtterance", "SpeechSynthesisUtterance()")}}
  • : Returns a new SpeechSynthesisUtterance object instance.

Instance properties

SpeechSynthesisUtterance also inherits properties from its parent interface, {{domxref("EventTarget")}}.

• {{domxref("SpeechSynthesisUtterance.lang")}}
  • : Gets and sets the language of the utterance.
• {{domxref("SpeechSynthesisUtterance.pitch")}}
  • : Gets and sets the pitch at which the utterance will be spoken at.
• {{domxref("SpeechSynthesisUtterance.rate")}}
  • : Gets and sets the speed at which the utterance will be spoken at.
• {{domxref("SpeechSynthesisUtterance.text")}}
  • : Gets and sets the text that will be synthesized when the utterance is spoken.
• {{domxref("SpeechSynthesisUtterance.voice")}}
  • : Gets and sets the voice that will be used to speak the utterance.
• {{domxref("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 the onboundary property.
• end
  • : Fired when the utterance has finished being spoken. Also available via the onend property.
• error
  • : Fired when an error occurs that prevents the utterance from being successfully spoken. Also available via the onerror property
• mark
  • : Fired when the spoken utterance reaches a named SSML "mark" tag. Also available via the onmark property.
• pause
  • : Fired when the utterance is paused part way through. Also available via the onpause property.
• resume
  • : Fired when a paused utterance is resumed. Also available via the onresume property.
• start
  • : Fired when the utterance has begun to be spoken. Also available via the onstart property.

Examples

In our basic Speech synthesizer demo, 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.

const synth = window.speechSynthesis;

const inputForm = document.querySelector("form");
const inputTxt = document.querySelector("input");
const voiceSelect = document.querySelector("select");

let voices;

function loadVoices() {
  voices = synth.getVoices();
  for (const [i, voice] of voices.entries()) {
    const option = document.createElement("option");
    option.textContent = `${voice.name} (${voice.lang})`;
    option.value = i;
    voiceSelect.appendChild(option);
  }
}

// in Google Chrome the voices are not ready on page load
if ("onvoiceschanged" in synth) {
  synth.onvoiceschanged = loadVoices;
} else {
  loadVoices();
}

inputForm.onsubmit = (event) => {
  event.preventDefault();

  const utterThis = new SpeechSynthesisUtterance(inputTxt.value);
  utterThis.voice = voices[voiceSelect.value];
  synth.speak(utterThis);
  inputTxt.blur();
};

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Web Speech API