ai-elements-ui/dev.ai.elements.ui.voice/SpeechOutputState

SpeechOutputState

@Stable

Speech output on the platform text-to-speech engine (Android TextToSpeech): reads a message aloud, or a reply sentence by sentence while it streams (enqueue). One utterance group is active at a time, named by speakingId; stop ends it.

Properties

engines

var engines: List<TextToSpeech.EngineInfo>

The text-to-speech engines installed on the device (for a settings screen).

isAvailable

var isAvailable: Boolean

False until the engine is ready, and when the device has none.

speakingId

var speakingId: String?

The id of what is being read (e.g. a message id), or null when silent.

voices

var voices: List<Voice>

The voices of the engine in use, once it is ready (for a settings screen).

Functions

enqueue

fun enqueue(id: String, text: String, locale: Locale? = null, onDone: () -> Unit? = null)

Add text after what id is already reading (a streaming reply, sentence by sentence).

isSpeaking

fun isSpeaking(id: String): Boolean

Whether id still has text queued or playing.

speak

fun speak(id: String, text: String, locale: Locale? = null, onDone: () -> Unit? = null)

Read text (plain text, see speakableText) as id, replacing whatever is being read.

stop

fun stop()