tts/org.w3c.speech/SpeechSynthesis

SpeechSynthesis

external interface SpeechSynthesis(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.

Functions

cancel

abstract fun cancel()

Removes all utterances from the utterance queue.

getVoices

abstract fun getVoices(): Array<SpeechSynthesisVoice>

Returns a list of SpeechSynthesisVoice objects representing all the available voices on the current device.

pause

abstract fun pause()

Puts the SpeechSynthesis object into a paused state.

resume

abstract fun resume()

Puts the SpeechSynthesis object into a non-paused state: resumes it if it was already paused.

speak

abstract fun speak(utterance: SpeechSynthesisUtterance)

Adds an utterance to the utterance queue; it will be spoken when any other utterances queued before it have been spoken.

Properties

paused

abstract val paused: Boolean

A Boolean that returns true if the SpeechSynthesis object is in a paused state.

pending

abstract val pending: Boolean

A Boolean that returns true if the utterance queue contains as-yet-unspoken utterances.

speaking

abstract val speaking: Boolean

A Boolean that returns true if an utterance is currently in the process of being spoken — even if SpeechSynthesis is in a paused state.