SynthesisRequest

public final class SynthesisRequest
extends Object

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


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 TextToSpeech.setLanguage(Locale) instead of TextToSpeech.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 TextToSpeech.speak(CharSequence, int, Bundle, String) and TextToSpeech.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.

Inherited methods

Public constructors

SynthesisRequest

added in API level 14
public SynthesisRequest (String text, 
                Bundle params)

Parameters
text String

params Bundle

SynthesisRequest

added in API level 21
public SynthesisRequest (CharSequence text, 
                Bundle params)

Parameters
text CharSequence

params Bundle

Public methods

getCallerUid

added in API level 19
public int getCallerUid ()

Gets the request caller Uid.

Returns
int

getCharSequenceText

added in API level 21
public CharSequence getCharSequenceText ()

Gets the text which should be synthesized.

Returns
CharSequence

getCountry

added in API level 14
public String getCountry ()

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

Returns
String

getLanguage

added in API level 14
public String getLanguage ()

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

Returns
String

getParams

added in API level 14
public Bundle getParams ()

Gets the additional params, if any.

Returns
Bundle

getPitch

added in API level 14
public int getPitch ()

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

Returns
int

getSpeechRate

added in API level 14
public int getSpeechRate ()

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

Returns
int

getText

added in API level 14
public String getText ()

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

Gets the text which should be synthesized.

Returns
String

getVariant

added in API level 14
public String getVariant ()

Gets the language variant to use.

Returns
String

getVoiceName

added in API level 21
public String getVoiceName ()

Gets the name of the voice to use.

Returns
String