SpeechSynthesisVoice.default

Experimental

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

The default read-only property of the SpeechSynthesisVoice interface returns a boolean value indicating whether the voice is the default voice for the current app (true), or not (false.)

Note: For some devices, it might be the default voice for the voice's language. The spec is not very clear on which it should be, so some implementations may differ.

Syntax

var amIDefault = speechSynthesisVoiceInstance.default;

Value

A boolean value.

Examples

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);
  voiceSelect.appendChild(option);
}

Specifications

Specification
Web Speech API
# dom-speechsynthesisvoice-default

Browser compatibility

BCD tables only load in the browser

See also