SpeechSynthesis.getVoices()

Jump to:
  1. Syntax
  2. Example
  3. Specifications
  4. Browser compatibility
  5. See also

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support33 Yes49 No217
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support3333 Yes

62

61 — 621

 No7.1 ?

1. From version 61 until version 62 (exclusive): this feature is behind the media.webspeech.synth.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.

See also

Document Tags and Contributors

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