SpeechSynthesisUtterance: start event
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2018.
The start event of the Web Speech API SpeechSynthesisUtterance object is fired when the utterance has begun to be spoken.
Syntax
Use the event name in methods like addEventListener(), or set an event handler property.
addEventListener("start", (event) => { })
onstart = (event) => { }
Event type
A SpeechSynthesisEvent. Inherits from Event.
Event properties
In addition to the properties listed below, properties from the parent interface, Event, are available.
charIndexRead only-
Returns the index position of the character in the
SpeechSynthesisUtterance.textthat was being spoken when the event was triggered. elapsedTimeRead only-
Returns the elapsed time in seconds after the
SpeechSynthesisUtterance.textstarted being spoken that the event was triggered at. nameRead only-
Returns the name associated with certain types of events occurring as the
SpeechSynthesisUtterance.textis being spoken: the name of the SSML marker reached in the case of amarkevent, or the type of boundary reached in the case of aboundaryevent. utteranceRead only-
Returns the
SpeechSynthesisUtteranceinstance that the event was triggered on.
Examples
You can use the start event in an addEventListener method:
utterThis.addEventListener("start", (event) => {
console.log(`We have started uttering this speech: ${event.utterance.text}`);
});
Or use the onstart event handler property:
utterThis.onstart = (event) => {
console.log(`We have started uttering this speech: ${event.utterance.text}`);
};
Specifications
| Specification |
|---|
| Web Speech API> # eventdef-speechsynthesisutterance-start> |
| Web Speech API> # dom-speechsynthesisutterance-onstart> |
Browser compatibility
Loading…