readium-navigator-media-tts/org.readium.navigator.media.tts.android/AndroidTtsEngine

AndroidTtsEngine

class AndroidTtsEngine : TtsEngine<AndroidTtsSettings, AndroidTtsPreferences, AndroidTtsEngine.Error, AndroidTtsEngine.Voice>

Default TtsEngine implementation using Android's native text to speech engine.

Types

object Companion

sealed class Error : TtsEngine.Error

SettingsResolver

fun interface SettingsResolver

data class Voice(val id: AndroidTtsEngine.Voice.Id, val language: Language, val quality: AndroidTtsEngine.Voice.Quality = Quality.Normal, val requiresNetwork: Boolean = false) : TtsEngine.Voice

Represents a voice provided by the TTS engine which can speak an utterance.

fun interface VoiceSelector

Properties

open override val settings: StateFlow<AndroidTtsSettings>

open override val voices: Set<AndroidTtsEngine.Voice>

Sets of voices available with this TtsEngine.

Functions

open override fun close()

open override fun setListener(listener: TtsEngine.Listener<AndroidTtsEngine.Error>?)

Sets a new listener or removes the current one.

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

Enqueues a new speak request.

open override fun stop()

Stops the TtsEngine.

submitPreferences

open override fun submitPreferences(preferences: AndroidTtsPreferences)