kotlin-browser/web.speech/SpeechSynthesis

SpeechSynthesis

class SpeechSynthesis : EventTarget(source)

The SpeechSynthesis interface of the Web Speech API is the controller interface for the speech service; this can be used to retrieve information about the synthesis voices available on the device, start and pause speech, and other commands besides.

MDN Reference

Properties

onvoiceschanged

var onvoiceschanged: EventHandler<Event, SpeechSynthesis, SpeechSynthesis>?

MDN Reference

paused

val paused: Boolean

The paused read-only property of the true if the SpeechSynthesis object is in a paused state, or false if not.

pending

val pending: Boolean

The pending read-only property of the true if the utterance queue contains as-yet-unspoken utterances.

speaking

val speaking: Boolean

The speaking read-only property of the true if an utterance is currently in the process of being spoken — even if SpeechSynthesis is in a A boolean value.

voicesChangedEvent

val voicesChangedEvent: EventInstance<Event, SpeechSynthesis, SpeechSynthesis>

MDN Reference

Functions

cancel

fun cancel()

The cancel() method of the SpeechSynthesis interface removes all utterances from the utterance queue.

dispatchEvent

fun dispatchEvent(event: Event): Boolean

getVoices

fun getVoices(): ReadonlyArray<SpeechSynthesisVoice>

The getVoices() method of the current device.

pause

fun pause()

The pause() method of the SpeechSynthesis interface puts the SpeechSynthesis object into a paused state.

resume

fun resume()

The resume() method of the SpeechSynthesis interface puts the SpeechSynthesis object into a non-paused state: resumes it if it was already paused.

speak

fun speak(utterance: SpeechSynthesisUtterance)

The speak() method of the SpeechSynthesis interface adds an SpeechSynthesisUtterance to the utterance queue; it will be spoken when any other utterances queued before it have been spoken.

when

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