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

Link copied to clipboard
constructor(context: Context, language: Locale = LocaleProvider.preferredLocale())

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open override val supportedPhoneticAlphabets: List<String>

Supported phonetic alphabets. This engine supports only IPA_PHONETIC_ALPHABET.

Functions

Link copied to clipboard
open override fun addOnEngineReadyListener(listener: OnEngineReadyListener)

Sets a listener to report on the readiness of the TextToSpeechEngine.

Link copied to clipboard
open override fun changeLanguage(language: Locale)

Changes the language that is used to synthesize audio messages.

Link copied to clipboard
open override fun close()
Link copied to clipboard
open override fun currentLanguage(): Locale?

Returns the current language used to synthesize audio messages.

Link copied to clipboard
open override fun isLanguageAvailable(language: Locale): Boolean

Checks whether the specified language as represented by the Locale is available.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
open override fun removeOnEngineReadyListener(listener: OnEngineReadyListener)

Removes the listener that reports on the readiness of the TextToSpeechEngine.

Link copied to clipboard
open override fun stopMessagePlayback()

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