SpeechSynthesis.cancel()

Experimental

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

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

speechSynthesisInstance.cancel();

Returns

Void.

Parameters

None.

Examples

var synth = window.speechSynthesis;

var utterance1 = new SpeechSynthesisUtterance('How about we say this now? This is quite a long sentence to say.');
var 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 Status Comment
Web Speech API
The definition of 'cancel()' in that specification.
Draft

Browser compatibility

BCD tables only load in the browser

See also