@nextcloud/dialogs
    Preparing search index...

    Interface SpeechSynthesisUtterance

    The SpeechSynthesisUtterance interface of the Web Speech API represents a speech request.

    MDN Reference

    interface SpeechSynthesisUtterance {
        lang: string;
        onboundary:
            | ((this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any)
            | null;
        onend:
            | ((this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any)
            | null;
        onerror:
            | (
                (this: SpeechSynthesisUtterance, ev: SpeechSynthesisErrorEvent) => any
            )
            | null;
        onmark:
            | ((this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any)
            | null;
        onpause:
            | ((this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any)
            | null;
        onresume:
            | ((this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any)
            | null;
        onstart:
            | ((this: SpeechSynthesisUtterance, ev: SpeechSynthesisEvent) => any)
            | null;
        pitch: number;
        rate: number;
        text: string;
        voice: SpeechSynthesisVoice | null;
        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
    Index

    Properties

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

    Methods

    addEventListener dispatchEvent removeEventListener

    Properties

    lang: string

    The lang property of the SpeechSynthesisUtterance interface gets and sets the language of the utterance.

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

    pitch: number

    The pitch property of the SpeechSynthesisUtterance interface gets and sets the pitch at which the utterance will be spoken at.

    MDN Reference

    rate: number

    The rate property of the SpeechSynthesisUtterance interface gets and sets the speed at which the utterance will be spoken at.

    MDN Reference

    text

    text: string

    The text property of the The text may be provided as plain text, or a well-formed SSML document.

    MDN Reference

    voice: SpeechSynthesisVoice | null

    The voice property of the SpeechSynthesisUtterance interface gets and sets the voice that will be used to speak the utterance.

    MDN Reference

    volume: number

    The volume property of the SpeechSynthesisUtterance interface gets and sets the volume that the utterance will be spoken at.

    MDN Reference

    Methods

    • 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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods