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.)

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

Hierarchy (view full)

Properties

lang: string
onboundary: null | ((this, ev) => any)

Type declaration

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

Type declaration

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

Type declaration

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

Type declaration

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

Type declaration

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

Type declaration

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

Type declaration

pitch: number
rate: number
text: string
voice: null | SpeechSynthesisVoice
volume: number

Methods

  • 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.

    Type Parameters

    Parameters

    Returns void

  • Parameters

    Returns void

  • 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.

    Parameters

    Returns boolean