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. It contains the content the speech service should read and information about how to read it (e.g., language, pitch and volume.)

MDN Reference

Constructors

constructor(text: String = definedExternally)

Properties

lang

var lang: String

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

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

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.

text

var text: String

The text property of the SpeechSynthesisUtterance interface gets and sets the text that will be synthesized when the utterance is spoken.

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

open fun dispatchEvent(event: Event): Boolean

when

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