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.

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

Hierarchy

  • EventTarget
    • SpeechSynthesis

Properties

onvoiceschanged paused pending speaking

Methods

addEventListener cancel dispatchEvent getVoices pause removeEventListener resume speak

Properties

onvoiceschanged

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

Type declaration

Readonly paused

paused: boolean

Readonly pending

pending: boolean

Readonly speaking

speaking: boolean

Methods

addEventListener

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

  • Type Parameters

    • K extends "voiceschanged"

    Parameters

    Returns void

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

  • Parameters

    Returns void

cancel

  • cancel(): void

  • Returns void

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.

    Parameters

    • event: Event

    Returns boolean

getVoices

pause

  • pause(): void

  • Returns void

removeEventListener

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

  • Type Parameters

    • K extends "voiceschanged"

    Parameters

    Returns void

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

  • Parameters

    Returns void

resume

  • resume(): void

  • Returns void

speak

  • speak(utterance): void

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc