SynthesisRequest

extends Object

java.lang.Object
↳	android.speech.tts.SynthesisRequest

Class Overview

Contains data required by engines to synthesize speech. This data is:

The text to synthesize
The synthesis locale, represented as a language, country and a variant. The language is an ISO 639-3 letter language code, and the country is an ISO 3166 alpha 3 code. The variant is not specified.
The name of the voice requested for this synthesis. May be empty if the client uses setLanguage(Locale) instead of setVoice(Voice)
The synthesis speech rate, with 100 being the normal, and higher values representing higher speech rates.
The voice pitch, with 100 being the default pitch.

Any additional parameters sent to the text to speech service are passed in uninterpreted, see the params argument in speak(CharSequence, int, Bundle, String) and synthesizeToFile(CharSequence, Bundle, File, String).

Summary

Public Constructors
	SynthesisRequest(String text, Bundle params)
	SynthesisRequest(CharSequence text, Bundle params)

Public Methods
int	getCallerUid() Gets the request caller Uid.
CharSequence	getCharSequenceText() Gets the text which should be synthesized.
String	getCountry() Gets the ISO 3-letter country code for the language to use.
String	getLanguage() Gets the ISO 3-letter language code for the language to use.
Bundle	getParams() Gets the additional params, if any.
int	getPitch() Gets the pitch to use.
int	getSpeechRate() Gets the speech rate to use.
String	getText() This method was deprecated in API level 21. As of API level 21, replaced by `getCharSequenceText()`.
String	getVariant() Gets the language variant to use.
String	getVoiceName() Gets the name of the voice to use.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.