TextToSpeech

ACTION_TTS_QUEUE_PROCESSING_COMPLETED

String ACTION_TTS_QUEUE_PROCESSING_COMPLETED

Broadcast Action: The TextToSpeech synthesizer has completed processing of all the text in the speech queue. Note that this notifies callers when the engine has finished has processing text data. Audio playback might not have completed (or even started) at this point. If you wish to be notified when this happens, see TextToSpeech.OnUtteranceCompletedListener.

Constant Value: "android.speech.tts.TTS_QUEUE_PROCESSING_COMPLETED"

ERROR

int ERROR

Denotes a generic operation failure.

Constant Value: -1 (0xffffffff)

ERROR_INVALID_REQUEST

int ERROR_INVALID_REQUEST

Denotes a failure caused by an invalid request.

Constant Value: -8 (0xfffffff8)

ERROR_NETWORK

int ERROR_NETWORK

Denotes a failure caused by a network connectivity problems.

Constant Value: -6 (0xfffffffa)

ERROR_NETWORK_TIMEOUT

int ERROR_NETWORK_TIMEOUT

Denotes a failure caused by network timeout.

Constant Value: -7 (0xfffffff9)

ERROR_NOT_INSTALLED_YET

int ERROR_NOT_INSTALLED_YET

Denotes a failure caused by an unfinished download of the voice data.

Constant Value: -9 (0xfffffff7)

ERROR_OUTPUT

int ERROR_OUTPUT

Denotes a failure related to the output (audio device or a file).

Constant Value: -5 (0xfffffffb)

ERROR_SERVICE

int ERROR_SERVICE

Denotes a failure of a TTS service.

Constant Value: -4 (0xfffffffc)

ERROR_SYNTHESIS

int ERROR_SYNTHESIS

Denotes a failure of a TTS engine to synthesize the given input.

Constant Value: -3 (0xfffffffd)

LANG_AVAILABLE

int LANG_AVAILABLE

Denotes the language is available for the language by the locale, but not the country and variant.

Constant Value: 0 (0x00000000)

LANG_COUNTRY_AVAILABLE

int LANG_COUNTRY_AVAILABLE

Denotes the language is available for the language and country specified by the locale, but not the variant.

Constant Value: 1 (0x00000001)

LANG_COUNTRY_VAR_AVAILABLE

int LANG_COUNTRY_VAR_AVAILABLE

Denotes the language is available exactly as specified by the locale.

Constant Value: 2 (0x00000002)

LANG_MISSING_DATA

int LANG_MISSING_DATA

Denotes the language data is missing.

Constant Value: -1 (0xffffffff)

LANG_NOT_SUPPORTED

int LANG_NOT_SUPPORTED

Denotes the language is not supported.

Constant Value: -2 (0xfffffffe)

QUEUE_ADD

int QUEUE_ADD

Queue mode where the new entry is added at the end of the playback queue.

Constant Value: 1 (0x00000001)

QUEUE_FLUSH

int QUEUE_FLUSH

Queue mode where all entries in the playback queue (media to be played and text to be synthesized) are dropped and replaced by the new entry. Queues are flushed with respect to a given calling app. Entries in the queue from other callees are not discarded.

Constant Value: 0 (0x00000000)

STOPPED

int STOPPED

Denotes a stop requested by a client. It's used only on the service side of the API, client should never expect to see this result code.

Constant Value: -2 (0xfffffffe)

SUCCESS

int SUCCESS

Denotes a successful operation.

Constant Value: 0 (0x00000000)

TextToSpeech

TextToSpeech (Context context, 
                TextToSpeech.OnInitListener listener)

The constructor for the TextToSpeech class, using the default TTS engine. This will also initialize the associated TextToSpeech engine if it isn't already running.

TextToSpeech

TextToSpeech (Context context, 
                TextToSpeech.OnInitListener listener, 
                String engine)

The constructor for the TextToSpeech class, using the given TTS engine. This will also initialize the associated TextToSpeech engine if it isn't already running.

addEarcon

int addEarcon (String earcon, 
                String packagename, 
                int resourceId)

Adds a mapping between a string of text and a sound resource in a package. Use this to add custom earcons.

addEarcon

int addEarcon (String earcon, 
                String filename)

This method was deprecated in API level 21.
As of API level 21, replaced by addEarcon(String, File).

Adds a mapping between a string of text and a sound file. Use this to add custom earcons.

addEarcon

int addEarcon (String earcon, 
                File file)

Adds a mapping between a string of text and a sound file. Use this to add custom earcons.

addSpeech

int addSpeech (CharSequence text, 
                File file)

Adds a mapping between a CharSequence (may be spanned with TtsSpans and a sound file. Using this, it is possible to add custom pronounciations for a string of text. After a call to this method, subsequent calls to speak(String, int, HashMap) will play the specified sound resource if it is available, or synthesize the text it is missing.

addSpeech

int addSpeech (String text, 
                String packagename, 
                int resourceId)

Adds a mapping between a string of text and a sound resource in a package. After a call to this method, subsequent calls to speak(String, int, HashMap) will play the specified sound resource if it is available, or synthesize the text it is missing.

addSpeech

int addSpeech (CharSequence text, 
                String packagename, 
                int resourceId)

Adds a mapping between a CharSequence (may be spanned with TtsSpans) of text and a sound resource in a package. After a call to this method, subsequent calls to speak(String, int, HashMap) will play the specified sound resource if it is available, or synthesize the text it is missing.

addSpeech

int addSpeech (String text, 
                String filename)

Adds a mapping between a string of text and a sound file. Using this, it is possible to add custom pronounciations for a string of text. After a call to this method, subsequent calls to speak(String, int, HashMap) will play the specified sound resource if it is available, or synthesize the text it is missing.

areDefaultsEnforced

boolean areDefaultsEnforced ()

Checks whether the user's settings should override settings requested by the calling application. As of the Ice cream sandwich release, user settings never forcibly override the app's settings.

getAvailableLanguages

Set<Locale> getAvailableLanguages ()

Query the engine about the set of available languages.

getDefaultEngine

String getDefaultEngine ()

Gets the package name of the default speech synthesis engine.

getDefaultLanguage

Locale getDefaultLanguage ()

This method was deprecated in API level 21.
As of API level 21, use getDefaultVoice().getLocale() (getDefaultVoice())

Returns a Locale instance describing the language currently being used as the default Text-to-speech language. The locale object returned by this method is NOT a valid one. It has identical form to the one in getLanguage(). Please refer to getLanguage() for more information.

getDefaultVoice

Voice getDefaultVoice ()

Returns a Voice instance that's the default voice for the default Text-to-speech language.

getEngines

List<TextToSpeech.EngineInfo> getEngines ()

Gets a list of all installed TTS engines.

getFeatures

Set<String> getFeatures (Locale locale)

This method was deprecated in API level 21.
As of API level 21, please use voices. In order to query features of the voice, call getVoices() to retrieve the list of available voices and getFeatures() to retrieve the set of features.

Queries the engine for the set of features it supports for a given locale. Features can either be framework defined, e.g. KEY_FEATURE_NETWORK_SYNTHESIS or engine specific. Engine specific keys must be prefixed by the name of the engine they are intended for. These keys can be used as parameters to speak(String, int, java.util.HashMap) and synthesizeToFile(String, java.util.HashMap, String). Features values are strings and their values must meet restrictions described in their documentation.

getLanguage

Locale getLanguage ()

This method was deprecated in API level 21.
As of API level 21, please use getVoice().getLocale() (getVoice()).

Returns a Locale instance describing the language currently being used for synthesis requests sent to the TextToSpeech engine. In Android 4.2 and before (API <= 17) this function returns the language that is currently being used by the TTS engine. That is the last language set by this or any other client by a setLanguage(Locale) call to the same engine. In Android versions after 4.2 this function returns the language that is currently being used for the synthesis requests sent from this client. That is the last language set by a setLanguage(Locale) call on this instance. If a voice is set (by setVoice(Voice)), getLanguage will return the language of the currently set voice. Please note that the Locale object returned by this method is NOT a valid Locale object. Its language field contains a three-letter ISO 639-2/T code (where a proper Locale would use a two-letter ISO 639-1 code), and the country field contains a three-letter ISO 3166 country code (where a proper Locale would use a two-letter ISO 3166-1 code).

getMaxSpeechInputLength

int getMaxSpeechInputLength ()

Limit of length of input string passed to speak and synthesizeToFile.

getVoice

Voice getVoice ()

Returns a Voice instance describing the voice currently being used for synthesis requests sent to the TextToSpeech engine.

getVoices

Set<Voice> getVoices ()

Query the engine about the set of available voices. Each TTS Engine can expose multiple voices for each locale, each with a different set of features.

isLanguageAvailable

int isLanguageAvailable (Locale loc)

Checks if the specified language as represented by the Locale is available and supported.

isSpeaking

boolean isSpeaking ()

Checks whether the TTS engine is busy speaking. Note that a speech item is considered complete once it's audio data has been sent to the audio mixer, or written to a file. There might be a finite lag between this point, and when the audio hardware completes playback.

playEarcon

int playEarcon (String earcon, 
                int queueMode, 
                HashMap<String, String> params)

This method was deprecated in API level 21.
As of API level 21, replaced by playEarcon(String, int, Bundle, String).

Plays the earcon using the specified queueing mode and parameters. The earcon must already have been added with addEarcon(String, String) or addEarcon(String, String, int). This method is asynchronous, i.e. the method just adds the request to the queue of TTS requests and then returns. The synthesis might not have finished (or even started!) at the time when this method returns. In order to reliably detect errors during synthesis, we recommend setting an utterance progress listener (see setOnUtteranceProgressListener(UtteranceProgressListener)) and using the KEY_PARAM_UTTERANCE_ID parameter.

playEarcon

int playEarcon (String earcon, 
                int queueMode, 
                Bundle params, 
                String utteranceId)

Plays the earcon using the specified queueing mode and parameters. The earcon must already have been added with addEarcon(String, String) or addEarcon(String, String, int). This method is asynchronous, i.e. the method just adds the request to the queue of TTS requests and then returns. The synthesis might not have finished (or even started!) at the time when this method returns. In order to reliably detect errors during synthesis, we recommend setting an utterance progress listener (see setOnUtteranceProgressListener(UtteranceProgressListener)) and using the KEY_PARAM_UTTERANCE_ID parameter.

playSilence

int playSilence (long durationInMs, 
                int queueMode, 
                HashMap<String, String> params)

This method was deprecated in API level 21.
As of API level 21, replaced by playSilentUtterance(long, int, String).

Plays silence for the specified amount of time using the specified queue mode. This method is asynchronous, i.e. the method just adds the request to the queue of TTS requests and then returns. The synthesis might not have finished (or even started!) at the time when this method returns. In order to reliably detect errors during synthesis, we recommend setting an utterance progress listener (see setOnUtteranceProgressListener(UtteranceProgressListener)) and using the KEY_PARAM_UTTERANCE_ID parameter.

playSilentUtterance

int playSilentUtterance (long durationInMs, 
                int queueMode, 
                String utteranceId)

Plays silence for the specified amount of time using the specified queue mode. This method is asynchronous, i.e. the method just adds the request to the queue of TTS requests and then returns. The synthesis might not have finished (or even started!) at the time when this method returns. In order to reliably detect errors during synthesis, we recommend setting an utterance progress listener (see setOnUtteranceProgressListener(UtteranceProgressListener)) and using the KEY_PARAM_UTTERANCE_ID parameter.

setAudioAttributes

int setAudioAttributes (AudioAttributes audioAttributes)

Sets the audio attributes to be used when speaking text or playing back a file.

setEngineByPackageName

int setEngineByPackageName (String enginePackageName)

This method was deprecated in API level 14.
This doesn't inform callers when the TTS engine has been initialized. TextToSpeech(Context, OnInitListener, String) can be used with the appropriate engine name. Also, there is no guarantee that the engine specified will be loaded. If it isn't installed or disabled, the user / system wide defaults will apply.

Sets the TTS engine to use.

setLanguage

int setLanguage (Locale loc)

Sets the text-to-speech language. The TTS engine will try to use the closest match to the specified language as represented by the Locale, but there is no guarantee that the exact same Locale will be used. Use isLanguageAvailable(Locale) to check the level of support before choosing the language to use for the next utterances. This method sets the current voice to the default one for the given Locale; getVoice() can be used to retrieve it.

setOnUtteranceCompletedListener

int setOnUtteranceCompletedListener (TextToSpeech.OnUtteranceCompletedListener listener)

This method was deprecated in API level 15.
Use setOnUtteranceProgressListener(UtteranceProgressListener) instead.

Sets the listener that will be notified when synthesis of an utterance completes.

setOnUtteranceProgressListener

int setOnUtteranceProgressListener (UtteranceProgressListener listener)

Sets the listener that will be notified of various events related to the synthesis of a given utterance. See UtteranceProgressListener and KEY_PARAM_UTTERANCE_ID.

setPitch

int setPitch (float pitch)

Sets the speech pitch for the TextToSpeech engine. This has no effect on any pre-recorded speech.

setSpeechRate

int setSpeechRate (float speechRate)

Sets the speech rate. This has no effect on any pre-recorded speech.

setVoice

int setVoice (Voice voice)

Sets the text-to-speech voice.

shutdown

void shutdown ()

Releases the resources used by the TextToSpeech engine. It is good practice for instance to call this method in the onDestroy() method of an Activity so the TextToSpeech engine can be cleanly stopped.

speak

int speak (CharSequence text, 
                int queueMode, 
                Bundle params, 
                String utteranceId)

Speaks the text using the specified queuing strategy and speech parameters, the text may be spanned with TtsSpans. This method is asynchronous, i.e. the method just adds the request to the queue of TTS requests and then returns. The synthesis might not have finished (or even started!) at the time when this method returns. In order to reliably detect errors during synthesis, we recommend setting an utterance progress listener (see setOnUtteranceProgressListener(UtteranceProgressListener)) and using the KEY_PARAM_UTTERANCE_ID parameter.

speak

int speak (String text, 
                int queueMode, 
                HashMap<String, String> params)

This method was deprecated in API level 21.
As of API level 21, replaced by speak(CharSequence, int, Bundle, String).

Speaks the string using the specified queuing strategy and speech parameters. This method is asynchronous, i.e. the method just adds the request to the queue of TTS requests and then returns. The synthesis might not have finished (or even started!) at the time when this method returns. In order to reliably detect errors during synthesis, we recommend setting an utterance progress listener (see setOnUtteranceProgressListener(UtteranceProgressListener)) and using the KEY_PARAM_UTTERANCE_ID parameter.

stop

int stop ()

Interrupts the current utterance (whether played or rendered to file) and discards other utterances in the queue.

synthesizeToFile

int synthesizeToFile (CharSequence text, 
                Bundle params, 
                File file, 
                String utteranceId)

Synthesizes the given text to a file using the specified parameters. This method is asynchronous, i.e. the method just adds the request to the queue of TTS requests and then returns. The synthesis might not have finished (or even started!) at the time when this method returns. In order to reliably detect errors during synthesis, we recommend setting an utterance progress listener (see setOnUtteranceProgressListener(UtteranceProgressListener)).

synthesizeToFile

int synthesizeToFile (String text, 
                HashMap<String, String> params, 
                String filename)

This method was deprecated in API level 21.
As of API level 21, replaced by synthesizeToFile(CharSequence, Bundle, File, String).

Synthesizes the given text to a file using the specified parameters. This method is asynchronous, i.e. the method just adds the request to the queue of TTS requests and then returns. The synthesis might not have finished (or even started!) at the time when this method returns. In order to reliably detect errors during synthesis, we recommend setting an utterance progress listener (see setOnUtteranceProgressListener(UtteranceProgressListener)) and using the KEY_PARAM_UTTERANCE_ID parameter.