Class SpeechSynthesisEvent

Namespace

CSharpToJavaScript.APIs.JS

Assembly

CSharpToJavaScript.dll

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.

[Value("SpeechSynthesisEvent")]
public class SpeechSynthesisEvent : Event

Inheritance

object

Event

SpeechSynthesisEvent

Derived

SpeechSynthesisErrorEvent

Inherited Members

Event.NONE

Event.CAPTURING_PHASE

Event.AT_TARGET

Event.BUBBLING_PHASE

Event.ComposedPath()

Event.StopPropagation()

Event.StopImmediatePropagation()

Event.PreventDefault()

Event.InitEvent(string, bool, bool)

Event.Type

Event.Target

Event.SrcElement

Event.CurrentTarget

Event.EventPhase

Event.CancelBubble

Event.Bubbles

Event.Cancelable

Event.ReturnValue

Event.DefaultPrevented

Event.Composed

Event.IsTrusted

Event.TimeStamp

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

-Web Speech API

See also on MDN

Constructors

SpeechSynthesisEvent()

public SpeechSynthesisEvent()

SpeechSynthesisEvent(string, SpeechSynthesisEventInit)

The SpeechSynthesisEvent() constructor creates a new SpeechSynthesisEvent object.

public SpeechSynthesisEvent(string type, SpeechSynthesisEventInit eventInitDict)

Parameters

type string

eventInitDict SpeechSynthesisEventInit

Remarks

NOTE

A web developer doesn't typically need to call this constructor, as the browser creates these objects itself when firing events.

-SpeechSynthesisErrorEvent

See also on MDN

Properties

CharIndex

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

[Value("charIndex")]
public ulong CharIndex { get; }

Property Value

ulong

A number.

Remarks

-Web Speech API

See also on MDN

CharLength

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

[Value("charLength")]
public ulong CharLength { get; }

Property Value

ulong

An integer.

Remarks

If the speech engine can't determine it, it returns 0.

See also on MDN

ElapsedTime

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

[Value("elapsedTime")]
public Number ElapsedTime { get; }

Property Value

Number

A float containing the elapsed time, in seconds.

NOTE

Early versions of the specification required the elapsed time in milliseconds.
Check the compatibility table below for your browser.

Remarks

-Web Speech API

See also on MDN

Name

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

[Value("name")]
public string Name { get; }

Property Value

string

A string.

Remarks

-Web Speech API

See also on MDN

Utterance

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

[Value("utterance")]
public SpeechSynthesisUtterance Utterance { get; }

Property Value

SpeechSynthesisUtterance

A SpeechSynthesisUtterance object.

Remarks

-Web Speech API

See also on MDN