Chartbreaker
    Preparing search index...

    Interface SpeechSynthesis

    The SpeechSynthesis interface of the Web Speech API is the controller interface for the speech service; this can be used to retrieve information about the synthesis voices available on the device, start and pause speech, and other commands besides.

    MDN Reference

    interface SpeechSynthesis {
        onvoiceschanged: null | ((this: SpeechSynthesis, ev: Event) => any);
        paused: boolean;
        pending: boolean;
        speaking: boolean;
        addEventListener<K extends "voiceschanged">(
            type: K,
            listener: (this: SpeechSynthesis, ev: SpeechSynthesisEventMap[K]) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        cancel(): void;
        dispatchEvent(event: Event): boolean;
        getVoices(): SpeechSynthesisVoice[];
        pause(): void;
        removeEventListener<K extends "voiceschanged">(
            type: K,
            listener: (this: SpeechSynthesis, ev: SpeechSynthesisEventMap[K]) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        resume(): void;
        speak(utterance: SpeechSynthesisUtterance): void;
    }

    Hierarchy

    • EventTarget
      • SpeechSynthesis
    Index

    Properties

    onvoiceschanged paused pending speaking

    Methods

    addEventListener cancel dispatchEvent getVoices pause removeEventListener resume speak

    Properties

    onvoiceschanged: null | ((this: SpeechSynthesis, ev: Event) => any)

    MDN Reference

    paused: boolean

    The paused read-only property of the true if the SpeechSynthesis object is in a paused state, or false if not.

    MDN Reference

    pending: boolean

    The pending read-only property of the true if the utterance queue contains as-yet-unspoken utterances.

    MDN Reference

    speaking: boolean

    The speaking read-only property of the true if an utterance is currently in the process of being spoken — even if SpeechSynthesis is in a A boolean value.

    MDN Reference

    Methods

    • The cancel() method of the SpeechSynthesis interface removes all utterances from the utterance queue.

      MDN Reference

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • The pause() method of the SpeechSynthesis interface puts the SpeechSynthesis object into a paused state.

      MDN Reference

      Returns void

    • The resume() method of the SpeechSynthesis interface puts the SpeechSynthesis object into a non-paused state: resumes it if it was already paused.

      MDN Reference

      Returns void

    • The speak() method of the SpeechSynthesis interface adds an SpeechSynthesisUtterance to the utterance queue; it will be spoken when any other utterances queued before it have been spoken.

      MDN Reference

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods