SpeechSynthesisVoice.localService

Experimental

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

The localService read-only property of the SpeechSynthesisVoice interface returns a Boolean indicating whether the voice is supplied by a local speech synthesizer service (true), or a remote speech synthesizer service (false.)

This property is provided to allow differentiation in the case that some voice options are provided by a remote service; it is possible that remote voices might have extra latency, bandwidth or cost associated with them, so such distinction may be useful.

Syntax

var amILocal = speechSynthesisVoiceInstance.localService;

Value

A Boolean.

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';
  }

  console.log(voices[i].localService);

  option.setAttribute('data-lang', voices[i].lang);
  option.setAttribute('data-name', voices[i].name);
  voiceSelect.appendChild(option);
}

Specifications

Specification Status Comment
Web Speech API
The definition of 'localService' in that specification.
Draft

Browser compatibility

BCD tables only load in the browser

See also