SpeechSynthesis.getVoices()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

The getVoices() method of the SpeechSynthesis interface returns a list of SpeechSynthesisVoice objects representing all the available voices on the current device.

Syntax

speechSynthesisInstance.getVoices();

Parameters

None.

Return value

A list (array) of SpeechSynthesisVoice objects.

Note: The spec wrongly lists this method as returning as a SpeechSynthesisVoiceList object, but this was in fact removed from the spec.

Example

JavaScript

function populateVoiceList() {
  if(typeof speechSynthesis === 'undefined') {
    return;
  }
  voices = speechSynthesis.getVoices();
  for(i = 0; i < voices.length ; i++) {
    var option = document.createElement('option');
    option.textContent = voices[i].name + ' (' + voices[i].lang + ')';
    if(voices[i].default) {
      option.textContent += ' -- DEFAULT';
    }
    option.setAttribute('data-lang', voices[i].lang);
    option.setAttribute('data-name', voices[i].name);
    document.getElementById("voiceSelect").appendChild(option);
  }
}
populateVoiceList();
if (typeof speechSynthesis !== 'undefined' && speechSynthesis.onvoiceschanged !== undefined) {
  speechSynthesis.onvoiceschanged = populateVoiceList;
}

HTML

<select id="voiceSelect"></select>

Specifications

Specification Status Comment
Web Speech API
The definition of 'getVoices()' in that specification.		 Draft Initial definition

Browser compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 33 (Yes) 49 (49) No support ? 7
Feature Android Chrome Edge Firefox Mobile (Gecko) Firefox OS IE Phone Opera Mobile Safari Mobile
Basic support (Yes) (Yes) (Yes) No support 2.0 No support No support 7.1

See also

Document Tags and Contributors

Tags: 
 Contributors to this page: abbycar, Sebastianz, chrisdavidmills
 Last updated by: abbycar,