SpeechSynthesis: cancel() method
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 cancel() method of the SpeechSynthesis
interface removes all utterances from the utterance queue.
If an utterance is currently being spoken, speaking will stop immediately.
Syntax
js
cancel()
Parameters
None.
Return value
None (undefined).
Examples
js
const synth = window.speechSynthesis;
const utterance1 = new SpeechSynthesisUtterance(
"How about we say this now? This is quite a long sentence to say.",
);
const utterance2 = new SpeechSynthesisUtterance(
"We should say another sentence too, just to be on the safe side.",
);
synth.speak(utterance1);
synth.speak(utterance2);
synth.cancel(); // utterance1 stops being spoken immediately, and both are removed from the queue
Specifications
| Specification |
|---|
| Web Speech API # dom-speechsynthesis-cancel |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
cancel
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support