Interface SpeechSynthesisEvent

The SpeechSynthesisEvent interface of the Web Speech API contains information about the current state of SpeechSynthesisUtterance objects that have been processed in the speech service.

MDN Reference

interface SpeechSynthesisEvent {
    AT_TARGET: 2;
    bubbles: boolean;
    BUBBLING_PHASE: 3;
    cancelable: boolean;
    cancelBubble: boolean;
    CAPTURING_PHASE: 1;
    charIndex: number;
    charLength: number;
    composed: boolean;
    currentTarget: EventTarget | null;
    defaultPrevented: boolean;
    elapsedTime: number;
    eventPhase: number;
    isTrusted: boolean;
    name: string;
    NONE: 0;
    returnValue: boolean;
    srcElement: EventTarget | null;
    target: EventTarget | null;
    timeStamp: number;
    type: string;
    utterance: SpeechSynthesisUtterance;
    composedPath(): EventTarget[];
    initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
    preventDefault(): void;
    stopImmediatePropagation(): void;
    stopPropagation(): void;
}
Hierarchy
Index

Properties

AT_TARGET bubbles BUBBLING_PHASE cancelable cancelBubble CAPTURING_PHASE charIndex charLength composed currentTarget defaultPrevented elapsedTime eventPhase isTrusted name NONE returnValue srcElement target timeStamp type utterance

Methods

composedPath initEvent preventDefault stopImmediatePropagation stopPropagation

Properties

AT_TARGET: 2
bubbles: boolean

The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.

MDN Reference

BUBBLING_PHASE: 3
cancelable: boolean

The cancelable read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.

MDN Reference

cancelBubble: boolean

The cancelBubble property of the Event interface is deprecated.

MDN Reference

CAPTURING_PHASE: 1
charIndex: number

The charIndex read-only property of the SpeechSynthesisUtterance interface returns the index position of the character in SpeechSynthesisUtterance.text that was being spoken when the event was triggered.

MDN Reference

charLength: number

The read-only charLength property of the SpeechSynthesisEvent interface returns the number of characters left to be spoken after the character at the SpeechSynthesisEvent.charIndex position.

MDN Reference

composed: boolean

The read-only composed property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.

MDN Reference

currentTarget: EventTarget | null

The currentTarget read-only property of the Event interface identifies the element to which the event handler has been attached.

MDN Reference

defaultPrevented: boolean

The defaultPrevented read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.

MDN Reference

elapsedTime: number

The elapsedTime read-only property of the SpeechSynthesisEvent returns the elapsed time in seconds, after the SpeechSynthesisUtterance.text started being spoken, at which the event was triggered.

MDN Reference

eventPhase: number

The eventPhase read-only property of the being evaluated.

MDN Reference

isTrusted: boolean

The isTrusted read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and false when the event was dispatched via The only exception is the click event, which initializes the isTrusted property to false in user agents.

MDN Reference

name: string

The name read-only property of the SpeechSynthesisUtterance interface returns the name associated with certain types of events occurring as the SpeechSynthesisUtterance.text is being spoken: the name of the SSML marker reached in the case of a SpeechSynthesisUtterance.mark_event event, or the type of boundary reached in the case of a SpeechSynthesisUtterance.boundary_event event.

MDN Reference

NONE: 0
returnValue: boolean

The Event property returnValue indicates whether the default action for this event has been prevented or not.

MDN Reference

srcElement: EventTarget | null

The deprecated Event.srcElement is an alias for the Event.target property.

MDN Reference

target: EventTarget | null

The read-only target property of the dispatched.

MDN Reference

timeStamp: number

The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.

MDN Reference

type: string

The type read-only property of the Event interface returns a string containing the event's type.

MDN Reference

utterance: SpeechSynthesisUtterance

The utterance read-only property of the SpeechSynthesisUtterance interface returns the SpeechSynthesisUtterance instance that the event was triggered on.

MDN Reference

Methods

  • The composedPath() method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.

    MDN Reference

    Returns EventTarget[]

  • The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().

    Parameters

    • type: string
    • Optionalbubbles: boolean
    • Optionalcancelable: boolean

    Returns void

    MDN Reference

  • The preventDefault() method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.

    MDN Reference

    Returns void

  • The stopImmediatePropagation() method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.

    MDN Reference

    Returns void

  • The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

    MDN Reference

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods