readium-navigator-media-tts/org.readium.navigator.media.tts/TtsEngine

TtsEngine

interface TtsEngine<S : TtsEngine.Settings, P : TtsEngine.Preferences<P>, E : TtsEngine.Error, V : TtsEngine.Voice> : Configurable<S, P> , Closeable

A text-to-speech engine synthesizes text utterances (e.g. sentence).

Inheritors

AndroidTtsEngine

Types

interface Error : Error

Marker interface for the errors that the TtsEngine returns.

interface Listener<E : TtsEngine.Error>

TTS engine callbacks.

interface Preferences<P : Configurable.Preferences<P>> : Configurable.Preferences<P>

value class RequestId(val value: String)

An id to identify a request to speak.

interface Settings : Configurable.Settings

interface Voice

Properties

abstract val settings: StateFlow<S>

abstract val voices: Set<V>

Sets of voices available with this TtsEngine.

Functions

abstract fun close()

abstract fun setListener(listener: TtsEngine.Listener<E>?)

Sets a new listener or removes the current one.

abstract fun speak(requestId: TtsEngine.RequestId, text: String, language: Language?)

Enqueues a new speak request.

abstract fun stop()

Stops the TtsEngine.

submitPreferences

abstract fun submitPreferences(preferences: P)