com.tomtom.sdk:tts-engine-android/com.tomtom.sdk.tts.android/AndroidTextToSpeechEngine

AndroidTextToSpeechEngine

class AndroidTextToSpeechEngine : TextToSpeechEngine

TextToSpeechEngine implementation based on Android's TextToSpeech.

Important: This is a Public Preview API. It may be changed or removed at any time.

Constructors

AndroidTextToSpeechEngine

constructor(context: Context, language: Locale = LocaleProvider.preferredLocale())

Types

object Companion

Properties

supportedPhoneticAlphabets

open override val supportedPhoneticAlphabets: List<String>

Supported phonetic alphabets. This engine supports only IPA_PHONETIC_ALPHABET.

Functions

addOnEngineReadyListener

open override fun addOnEngineReadyListener(listener: OnEngineReadyListener)

open override fun changeLanguage(language: Locale)

open override fun close()

currentLanguage

open override fun currentLanguage(): Locale?

isLanguageAvailable

open override fun isLanguageAvailable(language: Locale): Boolean

playAudioMessage

open override fun playAudioMessage(audioMessage: AudioMessage, playbackListener: MessagePlaybackListener)

Synthesizes an audio message. If another audioMessage is currently being processed this one will be added to the queue. If there is already another AudioMessages in the queue it will be flushed and replaced by this one.

playTaggedMessage

open override fun playTaggedMessage(taggedMessage: TaggedMessage, playbackListener: MessagePlaybackListener)

Synthesizes a tagged message. TaggedMessage is parsed into MessageType.Ssml format prior to being synthesized. PhoneticAlphabetNotSupportedError is thrown if an unsupported phonetic alphabet is used.

removeOnEngineReadyListener

open override fun removeOnEngineReadyListener(listener: OnEngineReadyListener)

stopMessagePlayback

open override fun stopMessagePlayback()

Stops synthesis of current AudioMessage and discards all messages in the queue.