Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Summary: Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 14

public final class

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 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(String, int, HashMap
          
           )

and


        
         
          , java.lang.String)">synthesizeToFile(String, HashMap
          
           , String)

Summary

Public Constructors
	SynthesisRequest ( String text, Bundle params)

Public Methods
int	getCallerUid () Gets the request caller Uid.
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 () Gets the text which should be synthesized.
String	getVariant () Gets the language variant 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.

Public Constructors

public SynthesisRequest ( String text, Bundle params)

Added in API level 14

Public Methods

public int getCallerUid ()

Added in API level 19

Gets the request caller Uid.

public String getCountry ()

Added in API level 14

Gets the ISO 3-letter country code for the language to use.

public String getLanguage ()

Added in API level 14

Gets the ISO 3-letter language code for the language to use.

public Bundle getParams ()

Added in API level 14

Gets the additional params, if any.

public int getPitch ()

Added in API level 14

Gets the pitch to use. The normal pitch is 100.

public int getSpeechRate ()

Added in API level 14

Gets the speech rate to use. The normal rate is 100.

public String getText ()

Added in API level 14

Gets the text which should be synthesized.

public String getVariant ()

Added in API level 14

Gets the language variant to use.

Results

Interfaces

Classes

SynthesisRequest

Class Overview

Summary

Public Constructors

public SynthesisRequest ( String text, Bundle params)

Public Methods

public int getCallerUid ()

public String getCountry ()

public String getLanguage ()

public Bundle getParams ()

public int getPitch ()

public int getSpeechRate ()

public String getText ()

public String getVariant ()