kotlin-browser/web.speech/SpeechSynthesisUtterance

SpeechSynthesisUtterance

open class SpeechSynthesisUtterance(var text: String = definedExternally) : EventTarget(source)

The SpeechSynthesisUtterance interface of the Web Speech API represents a speech request.

MDN Reference

Constructors

constructor(text: String = definedExternally)

Properties

boundaryEvent

val boundaryEvent: EventInstance<SpeechSynthesisEvent, SpeechSynthesisUtterance, SpeechSynthesisUtterance>

MDN Reference

endEvent

val endEvent: EventInstance<SpeechSynthesisEvent, SpeechSynthesisUtterance, SpeechSynthesisUtterance>

MDN Reference

errorEvent

val errorEvent: EventInstance<SpeechSynthesisErrorEvent, SpeechSynthesisUtterance, SpeechSynthesisUtterance>

MDN Reference

lang

var lang: String

The lang property of the SpeechSynthesisUtterance interface gets and sets the language of the utterance.

markEvent

val markEvent: EventInstance<SpeechSynthesisEvent, SpeechSynthesisUtterance, SpeechSynthesisUtterance>

MDN Reference

onboundary

var onboundary: EventHandler<SpeechSynthesisEvent, SpeechSynthesisUtterance, SpeechSynthesisUtterance>?

MDN Reference

onend

var onend: EventHandler<SpeechSynthesisEvent, SpeechSynthesisUtterance, SpeechSynthesisUtterance>?

MDN Reference

onerror

var onerror: EventHandler<SpeechSynthesisErrorEvent, SpeechSynthesisUtterance, SpeechSynthesisUtterance>?

MDN Reference

onmark

var onmark: EventHandler<SpeechSynthesisEvent, SpeechSynthesisUtterance, SpeechSynthesisUtterance>?

MDN Reference

onpause

var onpause: EventHandler<SpeechSynthesisEvent, SpeechSynthesisUtterance, SpeechSynthesisUtterance>?

MDN Reference

onresume

var onresume: EventHandler<SpeechSynthesisEvent, SpeechSynthesisUtterance, SpeechSynthesisUtterance>?

MDN Reference

onstart

var onstart: EventHandler<SpeechSynthesisEvent, SpeechSynthesisUtterance, SpeechSynthesisUtterance>?

MDN Reference

pauseEvent

val pauseEvent: EventInstance<SpeechSynthesisEvent, SpeechSynthesisUtterance, SpeechSynthesisUtterance>

MDN Reference

pitch

var pitch: Float

The pitch property of the SpeechSynthesisUtterance interface gets and sets the pitch at which the utterance will be spoken at.

rate

var rate: Float

The rate property of the SpeechSynthesisUtterance interface gets and sets the speed at which the utterance will be spoken at.

resumeEvent

val resumeEvent: EventInstance<SpeechSynthesisEvent, SpeechSynthesisUtterance, SpeechSynthesisUtterance>

MDN Reference

startEvent

val startEvent: EventInstance<SpeechSynthesisEvent, SpeechSynthesisUtterance, SpeechSynthesisUtterance>

MDN Reference

text

var text: String

The text property of the The text may be provided as plain text, or a well-formed SSML document.

voice

var voice: SpeechSynthesisVoice?

The voice property of the SpeechSynthesisUtterance interface gets and sets the voice that will be used to speak the utterance.

volume

var volume: Float

The volume property of the SpeechSynthesisUtterance interface gets and sets the volume that the utterance will be spoken at.

Functions

dispatchEvent

fun dispatchEvent(event: Event): Boolean

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>