Added in API level 21

Voice

---

Kotlin |Java

open class Voice : Parcelable

kotlin.Any
↳	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
static Int	LATENCY_HIGH Network based expected synthesizer latency (~200ms)
static Int	LATENCY_LOW Low expected synthesizer latency (~20ms)
static Int	LATENCY_NORMAL Normal expected synthesizer latency (~50ms)
static Int	LATENCY_VERY_HIGH Very slow network based expected synthesizer latency (> 200ms)
static Int	LATENCY_VERY_LOW Very low expected synthesizer latency (< 20ms)
static Int	QUALITY_HIGH High, human-like quality of speech synthesis
static Int	QUALITY_LOW Low, not human-like quality of speech synthesis
static Int	QUALITY_NORMAL Normal quality of speech synthesis
static Int	QUALITY_VERY_HIGH Very high, almost human-indistinguishable quality of speech synthesis
static Int	QUALITY_VERY_LOW Very low, but still intelligible quality of speech synthesis

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
Voice(name: String!, locale: Locale!, quality: Int, latency: Int, requiresNetworkConnection: Boolean, features: MutableSet<String!>!)

Public methods
open Int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
open Boolean	equals(other: Any?) Indicates whether some other object is "equal to" this one.
open MutableSet<String!>!	getFeatures() Returns the set of features it supports for a given voice.
open Int	getLatency()
open Locale!	getLocale()
open String!	getName()
open Int	getQuality()
open Int	hashCode() Returns a hash code value for the object.
open Boolean	isNetworkConnectionRequired()
open String	toString() Returns a string representation of the object.
open Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<Voice!>	CREATOR

Constants

LATENCY_HIGH

Added in API level 21

static val LATENCY_HIGH: Int

Network based expected synthesizer latency (~200ms)

Value: 400

LATENCY_LOW

Added in API level 21

static val LATENCY_LOW: Int

Low expected synthesizer latency (~20ms)

Value: 200

LATENCY_NORMAL

Added in API level 21

static val LATENCY_NORMAL: Int

Normal expected synthesizer latency (~50ms)

Value: 300

LATENCY_VERY_HIGH

Added in API level 21

static val LATENCY_VERY_HIGH: Int

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

Value: 500

LATENCY_VERY_LOW

Added in API level 21

static val LATENCY_VERY_LOW: Int

Very low expected synthesizer latency (< 20ms)

Value: 100

QUALITY_HIGH

Added in API level 21

static val QUALITY_HIGH: Int

High, human-like quality of speech synthesis

Value: 400

QUALITY_LOW

Added in API level 21

static val QUALITY_LOW: Int

Low, not human-like quality of speech synthesis

Value: 200

QUALITY_NORMAL

Added in API level 21

static val QUALITY_NORMAL: Int

Normal quality of speech synthesis

Value: 300

QUALITY_VERY_HIGH

Added in API level 21

static val QUALITY_VERY_HIGH: Int

Very high, almost human-indistinguishable quality of speech synthesis

Value: 500

QUALITY_VERY_LOW

Added in API level 21

static val QUALITY_VERY_LOW: Int

Very low, but still intelligible quality of speech synthesis

Value: 100

Public constructors

Voice

Added in API level 21

Voice(
    name: String!, 
    locale: Locale!, 
    quality: Int, 
    latency: Int, 
    requiresNetworkConnection: Boolean, 
    features: MutableSet<String!>!)

Public methods

describeContents

Added in API level 21

open fun describeContents(): Int

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(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 21

open fun equals(other: Any?): Boolean

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj	This value may be null.

Return
Boolean	true if this object is the same as the obj argument; false otherwise.

getFeatures

Added in API level 21

open fun getFeatures(): MutableSet<String!>!

Returns the set of features it supports for a given voice. Features can either be framework defined, e.g. TextToSpeech.Engine.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 TextToSpeech.speak(String, int, java.util.HashMap) and TextToSpeech.synthesizeToFile(String, java.util.HashMap, String). Features values are strings and their values must met restrictions described in their documentation.

Return
MutableSet<String!>!	Set instance. May return null on error.

getLatency

Added in API level 21

open fun getLatency(): Int

Return
Int	The voice's latency (lower is better)

See Also

• #LATENCY_VERY_LOW
• #LATENCY_LOW
• #LATENCY_NORMAL
• #LATENCY_HIGH
• #LATENCY_VERY_HIGH

getLocale

Added in API level 21

open fun getLocale(): Locale!

Return
Locale!	The voice's locale

getName

Added in API level 21

open fun getName(): String!

Return
String!	Unique voice name.

getQuality

Added in API level 21

open fun getQuality(): Int

Return
Int	The voice's quality (higher is better)

See Also

• #QUALITY_VERY_HIGH
• #QUALITY_HIGH
• #QUALITY_NORMAL
• #QUALITY_LOW
• #QUALITY_VERY_LOW

hashCode

Added in API level 21

open fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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 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 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.

Return
Int	a hash code value for this object.

isNetworkConnectionRequired

Added in API level 21

open fun isNetworkConnectionRequired(): Boolean

Return
Boolean	Does the Voice require a network connection to work.

toString

Added in API level 21

open fun toString(): String

Returns a string representation of the object.

Return
String	a string representation of the object.

writeToParcel

Added in API level 21

open fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest	Parcel: The Parcel in which the object should be written. This value cannot be null.
flags	Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: PARCELABLE_WRITE_RETURN_VALUE

Properties

CREATOR

Added in API level 21

static val CREATOR: Parcelable.Creator<Voice!>