SpeechSynthesisUtterance.volume

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for the proper prefixes to use 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 spec changes.

The volume property of the SpeechSynthesisUtterance interface gets and sets the volume that the utterance will be spoken at.

If not set, the default value 1 will be used.

Syntax

var myVolume = speechSynthesisUtteranceInstance.volume;
speechSynthesisUtteranceInstance.volume = 0.5;

Value

A float that represents the volume value, between 0 (lowest) and 1 (highest.)

If SSML is used, this value will be overridden by prosody tags in the markup.

Examples

var synth = window.speechSynthesis;

var inputForm = document.querySelector('form');
var inputTxt = document.querySelector('input');
var voiceSelect = document.querySelector('select');

var voices = synth.getVoices();

  ...

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

  var utterThis = new SpeechSynthesisUtterance(inputTxt.value);
  var selectedOption = voiceSelect.selectedOptions[0].getAttribute('data-name');
  for(i = 0; i < voices.length ; i++) {
    if(voices[i].name === selectedOption) {
      utterThis.voice = voices[i];
    }
  }
  utterThis.volume = 0.5;
  synth.speak(utterThis);
  inputTxt.blur();
}

Specifications

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

Feature	Chrome	Firefox (Gecko)	Internet Explorer	Opera	Safari (WebKit)
Basic support	33	44 (44) ^[1]	Not supported	Not supported	Not supported

Feature	Android	Chrome	Firefox Mobile (Gecko)	Firefox OS	IE Phone	Opera Mobile	Safari Mobile
Basic support	?	(Yes)	?	2.5	Not supported	Not supported	Not supported

[1] Can be enabled via the media.webspeech.synth.enabled flag in about:config.

SpeechSynthesisUtterance.volume

Syntax

Value

Examples

Specifications

Browser compatibility

See also

Document Tags and Contributors