TextToSpeech

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.

Denotes a generic operation failure.

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

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

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

Denotes the language data is missing.

Denotes the language is not supported.

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

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.

Denotes a successful operation.

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.

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.

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

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

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.

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.

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.

Gets the package name of the default speech synthesis engine.

Returns a Locale instance describing the language currently being used as the default Text-to-speech language.

Gets a list of all installed TTS engines.

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 are boolean flags, and their values in the synthesis parameters must be behave as per parseBoolean(String).

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.

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

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

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.

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.

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.

Sets the TTS engine to use.

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.

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

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.

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

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

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.

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.

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

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.