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
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
volume |
33 |
14 |
49 |
No |
21 |
7 |
No |
33 |
62 |
No |
7 |
3.0 |
See also
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisUtterance/volume