W3cubDocs

SpeechSynthesis.cancel

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 compatibilityUpdate compatibility data on GitHub

	Desktop
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari
Basic support	33	Yes	49	No	21	7

	Mobile
	Android webview	Chrome for Android	Edge Mobile	Firefox for Android	Opera for Android	iOS Safari	Samsung Internet
Basic support	4.4.3	33	Yes	62 62 61 — 62 Disabled Disabled From version 61 until version 62 (exclusive): this feature is behind the `media.webspeech.synth.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	No	7.1	?

SpeechSynthesis.cancel

Syntax

Returns

Parameters

Examples

Specifications

Browser compatibilityUpdate compatibility data on GitHub

See also