SpeechSynthesisEvent extension type

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.

API documentation sourced from MDN Web Docs.

on
Implemented types
Implementers
Available extensions

Constructors

SpeechSynthesisEvent(String type, SpeechSynthesisEventInit eventInitDict)
factory

Properties

bubbles → bool
The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.
no setterinherited
cancelable → bool
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.
no setterinherited
cancelBubble ↔ bool
The cancelBubble property of the Event interface is deprecated. Use Event.stopPropagation instead. Setting its value to true before returning from an event handler prevents propagation of the event. In later implementations, setting this to false does nothing. See Browser compatibility for details.
getter/setter pairinherited
charIndex → int
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.
no setter
charLength → int
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.
no setter
composed → bool
The read-only composed property of the Event interface returns a boolean value which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.
no setterinherited
currentTarget → EventTarget?
The currentTarget read-only property of the Event interface identifies the element to which the event handler has been attached.
no setterinherited
defaultPrevented → bool
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.
no setterinherited
elapsedTime → double
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.
no setter
eventPhase → int
The eventPhase read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isTrusted → bool
The isTrusted read-only property of the Event interface is a boolean value that is true 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 EventTarget.dispatchEvent. The only exception is the click event, which initializes the isTrusted property to false in user agents.
no setterinherited
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.
no setter
returnValue ↔ bool
The Event property returnValue indicates whether the default action for this event has been prevented or not.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
srcElement → EventTarget?
The deprecated Event.srcElement is an alias for the Event.target property. Use Event.target instead.
no setterinherited
target → EventTarget?
The read-only target property of the Event interface is a reference to the object onto which the event was dispatched. It is different from Event.currentTarget when the event handler is called during the bubbling or capturing phase of the event.
no setterinherited
timeStamp → double
The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.
no setterinherited
type → String
The type read-only property of the Event interface returns a string containing the event's type. It is set when the event is constructed and is the name commonly used to refer to the specific event, such as click, load, or error.
no setterinherited
utterance → SpeechSynthesisUtterance
The utterance read-only property of the SpeechSynthesisUtterance interface returns the SpeechSynthesisUtterance instance that the event was triggered on.
no setter

Methods

composedPath() → JSArray<EventTarget>
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. This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.
inherited
initEvent(String type, [bool bubbles, bool cancelable]) → void
The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
preventDefault() → void
The preventDefault() method of the Event interface tells the that if the event does not get explicitly handled, its default action should not be taken as it normally would be.
inherited
stopImmediatePropagation() → void
The stopImmediatePropagation() method of the Event interface prevents other listeners of the same event from being called.
inherited
stopPropagation() → void
The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. It does not, however, prevent any default behaviors from occurring; for instance, clicks on links are still processed. If you want to stop those behaviors, see the Event.preventDefault method. It also does not prevent propagation to other event-handlers of the current element. If you want to stop those, see Event.stopImmediatePropagation.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited