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

TtsEngineProvider

interface TtsEngineProvider<S : TtsEngine.Settings, P : TtsEngine.Preferences<P>, E : PreferencesEditor<P>, F : TtsEngine.Error, V : TtsEngine.Voice>

To be implemented by adapters for third-party TTS engines which can be used with TtsNavigator.

Inheritors

AndroidTtsEngineProvider

Functions

createEmptyPreferences

abstract fun createEmptyPreferences(): P

Creates an empty set of preferences of this TTS engine provider.

abstract suspend fun createEngine(publication: Publication, initialPreferences: P): Try<TtsEngine<S, P, F, V>, Error>

Creates a TtsEngine for publication and initialPreferences.

createPreferencesEditor

abstract fun createPreferencesEditor(publication: Publication, initialPreferences: P): E

Creates a preferences editor for publication and initialPreferences.

getPlaybackParameters

abstract fun getPlaybackParameters(settings: S): PlaybackParameters

Computes Media3 PlaybackParameters from the given settings.

abstract fun mapEngineError(error: F): PlaybackException

Maps an engine-specific error to Media3 PlaybackException.

updatePlaybackParameters

abstract fun updatePlaybackParameters(previousPreferences: P, playbackParameters: PlaybackParameters): P

Updates previousPreferences to honor the given Media3 playbackParameters.