SpeechSynthesisUtterance.volume

Experimental

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

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
Web Speech API
# dom-speechsynthesisutterance-volume

Browser compatibility

BCD tables only load in the browser

See also