SpeechSynthesis: voiceschanged event
The voiceschanged
event of the Web Speech API is fired when the list of SpeechSynthesisVoice
objects that would be returned by the SpeechSynthesis.getVoices()
method has changed (when the voiceschanged
event fires.)
Syntax
Use the event name in methods like addEventListener()
, or set an event handler property.
js
addEventListener("voiceschanged", (event) => {});
onvoiceschanged = (event) => {};
Event type
A generic Event
with no added properties.
Examples
This could be used to repopulate a list of voices that the user can choose between when the event fires. You can use the voiceschanged
event in an addEventListener
method:
js
const synth = window.speechSynthesis;
synth.addEventListener("voiceschanged", () => {
const voices = synth.getVoices();
for (let i = 0; i < voices.length; i++) {
const option = document.createElement("option");
option.textContent = `${voices[i].name} (${voices[i].lang})`;
option.setAttribute("data-lang", voices[i].lang);
option.setAttribute("data-name", voices[i].name);
voiceSelect.appendChild(option);
}
});
Or use the onvoiceschanged
event handler property:
js
const synth = window.speechSynthesis;
synth.onvoiceschanged = () => {
const voices = synth.getVoices();
for (let i = 0; i < voices.length; i++) {
const option = document.createElement("option");
option.textContent = `${voices[i].name} (${voices[i].lang})`;
option.setAttribute("data-lang", voices[i].lang);
option.setAttribute("data-name", voices[i].name);
voiceSelect.appendChild(option);
}
};
Specifications
Specification |
---|
Web Speech API # eventdef-speechsynthesis-voiceschanged |
Web Speech API # dom-speechsynthesis-onvoiceschanged |
Browser compatibility
BCD tables only load in the browser