//readium-navigator/org.readium.r2.navigator.media3.tts.android/AndroidTtsEngine

AndroidTtsEngine

[androidJvm]\ class AndroidTtsEngine : TtsEngine<AndroidTtsSettings, AndroidTtsPreferences, AndroidTtsEngine.Error, AndroidTtsEngine.Voice>

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

Types

Name	Summary
Companion	[androidJvm] object Companion
Error	[androidJvm] class Error(code: Int) : TtsEngine.Error
Listener	[androidJvm] interface Listener
SettingsResolver	[androidJvm] fun interface SettingsResolver
UtteranceListener	[androidJvm] class UtteranceListener(listener: TtsEngine.Listener<AndroidTtsEngine.Error>?) : UtteranceProgressListener
Voice	[androidJvm] 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.
VoiceSelector	[androidJvm] fun interface VoiceSelector

Functions

Name	Summary
close	[androidJvm] open override fun close()
setListener	[androidJvm] open override fun setListener(listener: TtsEngine.Listener<AndroidTtsEngine.Error>?) Sets a new listener or removes the current one.
speak	[androidJvm] open override fun speak(requestId: TtsEngine.RequestId, text: String, language: Language?) Enqueues a new speak request.
stop	[androidJvm] open override fun stop() Stops the TtsEngine.
submitPreferences	[androidJvm] open override fun submitPreferences(preferences: AndroidTtsPreferences) Submits a new set of Preferences to update the current Settings.

Properties

Name	Summary
settings	[androidJvm] open override val settings: StateFlow<AndroidTtsSettings> Current Settings values.
voices	[androidJvm] open override val voices: Set<AndroidTtsEngine.Voice> Sets of voices available with this TtsEngine.