Interface SpeechSynthesis

    This Web Speech API interface 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: ((this: SpeechSynthesis, ev: Event) => any);
        paused: boolean;
        pending: boolean;
        speaking: boolean;
        addEventListener<K>(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>(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

    Properties

    onvoiceschanged paused pending speaking

    Methods

    addEventListener cancel dispatchEvent getVoices pause removeEventListener resume speak

    Properties

    onvoiceschanged

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

    MDN Reference

    Readonlypaused

    paused: boolean

    MDN Reference

    Readonlypending

    pending: boolean

    MDN Reference

    Readonlyspeaking

    speaking: boolean

    MDN Reference

    Methods

    addEventListener

    • addEventListener<K>(type, listener, options?): void

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Type Parameters

      • K extends "voiceschanged"

      Parameters

      Returns void

    • addEventListener(type, listener, options?): void

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Parameters

      Returns void

    cancel

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      MDN Reference

      Parameters

      Returns boolean

    getVoices

    pause

    removeEventListener

    resume

    speak

    Settings

    Member Visibility

    On This Page

    Properties
    Methods