SpeechSynthesis

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

The SpeechSynthesis interface of the Web Speech API is the controller interface for the speech service; this can be used to retrieve information about the synthesis voices available on the device, start and pause speech, and other commands besides.

{{InheritanceDiagram}}

Instance properties

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

• {{domxref("SpeechSynthesis.paused")}} {{ReadOnlyInline}}
  • : A boolean value that returns true if the SpeechSynthesis object is in a paused state.
• {{domxref("SpeechSynthesis.pending")}} {{ReadOnlyInline}}
  • : A boolean value that returns true if the utterance queue contains as-yet-unspoken utterances.
• {{domxref("SpeechSynthesis.speaking")}} {{ReadOnlyInline}}
  • : A boolean value that returns true if an utterance is currently in the process of being spoken — even if SpeechSynthesis is in a paused state.

Instance methods

SpeechSynthesis also inherits methods from its parent interface, {{domxref("EventTarget")}}.

• {{domxref("SpeechSynthesis.cancel()")}}
  • : Removes all utterances from the utterance queue.
• {{domxref("SpeechSynthesis.getVoices()")}}
  • : Returns a list of {{domxref("SpeechSynthesisVoice")}} objects representing all the available voices on the current device.
• {{domxref("SpeechSynthesis.pause()")}}
  • : Puts the SpeechSynthesis object into a paused state.
• {{domxref("SpeechSynthesis.resume()")}}
  • : Puts the SpeechSynthesis object into a non-paused state: resumes it if it was already paused.
• {{domxref("SpeechSynthesis.speak()")}}
  • : Adds an {{domxref("SpeechSynthesisUtterance", "utterance")}} to the utterance queue; it will be spoken when any other utterances queued before it have been spoken.

Events

Listen to this event using addEventListener() or by assigning an event listener to the oneventname property of this interface.

• voiceschanged
  • : Fired when the list of {{domxref("SpeechSynthesisVoice")}} objects that would be returned by the {{domxref("SpeechSynthesis.getVoices()")}} method has changed. Also available via the onvoiceschanged property.

Examples

First, an example:

let utterance = new SpeechSynthesisUtterance("Hello world!");
speechSynthesis.speak(utterance);

Now we'll look at a more fully-fledged example. In our 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 preventDefault(), create a new {{domxref("SpeechSynthesisUtterance")}} instance containing the text from the text {{htmlelement("input")}}, set the utterance's 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(".txt");
const voiceSelect = document.querySelector("select");
const pitch = document.querySelector("#pitch");
const pitchValue = document.querySelector(".pitch-value");
const rate = document.querySelector("#rate");
const rateValue = document.querySelector(".rate-value");

let voices = [];

function populateVoiceList() {
  voices = synth.getVoices();

  for (const voice of voices) {
    const option = document.createElement("option");
    option.textContent = `${voice.name} (${voice.lang})`;

    if (voice.default) {
      option.textContent += " — DEFAULT";
    }

    option.setAttribute("data-lang", voice.lang);
    option.setAttribute("data-name", voice.name);
    voiceSelect.appendChild(option);
  }
}

populateVoiceList();
if (speechSynthesis.onvoiceschanged !== undefined) {
  speechSynthesis.onvoiceschanged = populateVoiceList;
}

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

  const utterThis = new SpeechSynthesisUtterance(inputTxt.value);
  const selectedOption =
    voiceSelect.selectedOptions[0].getAttribute("data-name");
  for (const voice of voices) {
    if (voice.name === selectedOption) {
      utterThis.voice = voice;
    }
  }
  utterThis.pitch = pitch.value;
  utterThis.rate = rate.value;
  synth.speak(utterThis);

  inputTxt.blur();
};

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Web Speech API