Skip to content

Most visited

Recently visited

navigation

Voice

public class Voice
extends Object implements Parcelable

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


Characteristics and features of a Text-To-Speech Voice. Each TTS Engine can expose multiple voices for each locale, with different set of features.

Summary

Constants

int LATENCY_HIGH

Network based expected synthesizer latency (~200ms)

int LATENCY_LOW

Low expected synthesizer latency (~20ms)

int LATENCY_NORMAL

Normal expected synthesizer latency (~50ms)

int LATENCY_VERY_HIGH

Very slow network based expected synthesizer latency (> 200ms)

int LATENCY_VERY_LOW

Very low expected synthesizer latency (< 20ms)

int QUALITY_HIGH

High, human-like quality of speech synthesis

int QUALITY_LOW

Low, not human-like quality of speech synthesis

int QUALITY_NORMAL

Normal quality of speech synthesis

int QUALITY_VERY_HIGH

Very high, almost human-indistinguishable quality of speech synthesis

int QUALITY_VERY_LOW

Very low, but still intelligible quality of speech synthesis

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<Voice> CREATOR

Public constructors

Voice(String name, Locale locale, int quality, int latency, boolean requiresNetworkConnection, Set<String> features)

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

Set<String> getFeatures()

Returns the set of features it supports for a given voice.

int getLatency()
Locale getLocale()
String getName()
int getQuality()
int hashCode()

Returns a hash code value for the object.

boolean isNetworkConnectionRequired()
String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Constants

LATENCY_HIGH

added in API level 21
int LATENCY_HIGH

Network based expected synthesizer latency (~200ms)

Constant Value: 400 (0x00000190)

LATENCY_LOW

added in API level 21
int LATENCY_LOW

Low expected synthesizer latency (~20ms)

Constant Value: 200 (0x000000c8)

LATENCY_NORMAL

added in API level 21
int LATENCY_NORMAL

Normal expected synthesizer latency (~50ms)

Constant Value: 300 (0x0000012c)

LATENCY_VERY_HIGH

added in API level 21
int LATENCY_VERY_HIGH

Very slow network based expected synthesizer latency (> 200ms)

Constant Value: 500 (0x000001f4)

LATENCY_VERY_LOW

added in API level 21
int LATENCY_VERY_LOW

Very low expected synthesizer latency (< 20ms)

Constant Value: 100 (0x00000064)

QUALITY_HIGH

added in API level 21
int QUALITY_HIGH

High, human-like quality of speech synthesis

Constant Value: 400 (0x00000190)

QUALITY_LOW

added in API level 21
int QUALITY_LOW

Low, not human-like quality of speech synthesis

Constant Value: 200 (0x000000c8)

QUALITY_NORMAL

added in API level 21
int QUALITY_NORMAL

Normal quality of speech synthesis

Constant Value: 300 (0x0000012c)

QUALITY_VERY_HIGH

added in API level 21
int QUALITY_VERY_HIGH

Very high, almost human-indistinguishable quality of speech synthesis

Constant Value: 500 (0x000001f4)

QUALITY_VERY_LOW

added in API level 21
int QUALITY_VERY_LOW

Very low, but still intelligible quality of speech synthesis

Constant Value: 100 (0x00000064)

Fields

CREATOR

added in API level 21
Creator<Voice> CREATOR

Public constructors

Voice

added in API level 21
Voice (String name, 
                Locale locale, 
                int quality, 
                int latency, 
                boolean requiresNetworkConnection, 
                Set<String> features)

Parameters
name String

locale Locale

quality int

latency int

requiresNetworkConnection boolean

features Set

Public methods

describeContents

added in API level 21
int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

equals

added in API level 21
boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
obj Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getFeatures

added in API level 21
Set<String> getFeatures ()

Returns the set of features it supports for a given voice. Features can either be framework defined, e.g. KEY_FEATURE_NETWORK_TIMEOUT_MS 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 met restrictions described in their documentation.

Returns
Set<String> Set instance. May return null on error.

getLatency

added in API level 21
int getLatency ()

Returns
int The voice's latency (lower is better)

getLocale

added in API level 21
Locale getLocale ()

Returns
Locale The voice's locale

getName

added in API level 21
String getName ()

Returns
String Unique voice name.

getQuality

added in API level 21
int getQuality ()

Returns
int The voice's quality (higher is better)

hashCode

added in API level 21
int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

isNetworkConnectionRequired

added in API level 21
boolean isNetworkConnectionRequired ()

Returns
boolean Does the Voice require a network connection to work.

toString

added in API level 21
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

added in API level 21
void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience. (Dec 2017 Android Platform & Tools Survey)