Interface SpeechSynthesisUtterance

This Web Speech API interface represents a speech request. It contains the content the speech service should read and information about how to read it (e.g. language, pitch and volume.)

MDN Reference

interface SpeechSynthesisUtterance {
    lang: string;
    onboundary:
        | null
        | (this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any;
    onend:
        | null
        | (this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any;
    onerror:
        | null
        | (this: SpeechSynthesisUtterance, ev: SpeechSynthesisErrorEvent) => any;
    onmark:
        | null
        | (this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any;
    onpause:
        | null
        | (this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any;
    onresume:
        | null
        | (this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any;
    onstart:
        | null
        | (this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any;
    pitch: number;
    rate: number;
    text: string;
    voice: null | SpeechSynthesisVoice;
    volume: number;
    addEventListener<K extends keyof SpeechSynthesisUtteranceEventMap>(
        type: K,
        listener: (
            this: SpeechSynthesisUtterance,
            ev: SpeechSynthesisUtteranceEventMap[K],
        ) => any,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    dispatchEvent(event: Event): boolean;
    removeEventListener<K extends keyof SpeechSynthesisUtteranceEventMap>(
        type: K,
        listener: (
            this: SpeechSynthesisUtterance,
            ev: SpeechSynthesisUtteranceEventMap[K],
        ) => any,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
}

Hierarchy

  • EventTarget
    • SpeechSynthesisUtterance

Properties

lang onboundary onend onerror onmark onpause onresume onstart pitch rate text voice volume

Methods

addEventListener dispatchEvent removeEventListener

Properties

lang

lang: string

MDN Reference

onboundary

onboundary:
    | null
    | (this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any

MDN Reference

onend

onend: null | (this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any

MDN Reference

onerror

onerror:
    | null
    | (this: SpeechSynthesisUtterance, ev: SpeechSynthesisErrorEvent) => any

MDN Reference

onmark

onmark: null | (this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any

MDN Reference

onpause

onpause:
    | null
    | (this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any

MDN Reference

onresume

onresume:
    | null
    | (this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any

MDN Reference

onstart

onstart:
    | null
    | (this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any

MDN Reference

pitch

pitch: number

MDN Reference

rate

rate: number

MDN Reference

text

text: string

MDN Reference

voice

voice: null | SpeechSynthesisVoice

MDN Reference

volume

volume: number

MDN Reference

Methods

addEventListener

  • addEventListener<K extends keyof SpeechSynthesisUtteranceEventMap>(
        type: K,
        listener: (
            this: SpeechSynthesisUtterance,
            ev: SpeechSynthesisUtteranceEventMap[K],
        ) => any,
        options?: boolean | AddEventListenerOptions,
    ): 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

    Parameters

    Returns void

  • addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): 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

dispatchEvent

  • dispatchEvent(event: 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

    • event: Event

    Returns boolean

removeEventListener

Settings

Member Visibility

On This Page

Properties
Methods