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

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

  • EventTarget
    • SpeechSynthesisUtterance

Properties

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

Methods

addEventListener dispatchEvent removeEventListener

Properties

lang

lang: string

onboundary

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

Type declaration

onend

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

Type declaration

onerror

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

Type declaration

onmark

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

Type declaration

onpause

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

Type declaration

onresume

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

Type declaration

onstart

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

Type declaration

pitch

pitch: number

rate

rate: number

text

text: string

voice

voice: null | SpeechSynthesisVoice

volume

volume: number

Methods

addEventListener

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

removeEventListener

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc