kotlin-browser/web.speech/SpeechSynthesisEvent

SpeechSynthesisEvent

open class SpeechSynthesisEvent(val type: EventType<SpeechSynthesisEvent>, init: SpeechSynthesisEventInit) : Event(source)

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

Inheritors

SpeechSynthesisErrorEvent

Constructors

SpeechSynthesisEvent

constructor(type: EventType<SpeechSynthesisEvent>, init: SpeechSynthesisEventInit)

Types

Companion

object Companion

Properties

AT_TARGET

val AT_TARGET: EventPhase

bubbles

val bubbles: Boolean

BUBBLING_PHASE

val BUBBLING_PHASE: EventPhase

cancelable

val cancelable: Boolean

CAPTURING_PHASE

val CAPTURING_PHASE: EventPhase

charIndex

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

charLength

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

composed

val composed: Boolean

currentTarget

val currentTarget: EventTarget?

defaultPrevented

val defaultPrevented: Boolean

elapsedTime

val elapsedTime: Float

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.

eventPhase

val eventPhase: EventPhase

isTrusted

val isTrusted: Boolean

name

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

NONE

val NONE: EventPhase

target

val target: EventTarget?

timeStamp

val timeStamp: DOMHighResTimeStamp

type

open override val type: EventType<SpeechSynthesisEvent>

utterance

val utterance: SpeechSynthesisUtterance

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

Functions

asInit

open override fun asInit(): SpeechSynthesisEventInit

composedPath

fun composedPath(): ReadonlyArray<EventTarget>

preventDefault

fun preventDefault()

stopImmediatePropagation

fun stopImmediatePropagation()

stopPropagation

fun stopPropagation()