Firefox Tomorrow

web api instance method

SpeechSynthesis: cancel() method

View on MDN ↗

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

cancel()

Parameters

None.

Return value

None (undefined).

Examples

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

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.

See also