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_HIGHNetwork based expected synthesizer latency (~200ms) | 
| int | LATENCY_LOWLow expected synthesizer latency (~20ms) | 
| int | LATENCY_NORMALNormal expected synthesizer latency (~50ms) | 
| int | LATENCY_VERY_HIGHVery slow network based expected synthesizer latency (> 200ms) | 
| int | LATENCY_VERY_LOWVery low expected synthesizer latency (< 20ms) | 
| int | QUALITY_HIGHHigh, human-like quality of speech synthesis | 
| int | QUALITY_LOWLow, not human-like quality of speech synthesis | 
| int | QUALITY_NORMALNormal quality of speech synthesis | 
| int | QUALITY_VERY_HIGHVery high, almost human-indistinguishable quality of speech synthesis | 
| int | QUALITY_VERY_LOWVery low, but still intelligible quality of speech synthesis | 
| Inherited constants | 
|---|
| 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 | |
|---|---|
Constants
LATENCY_HIGH
public static final int LATENCY_HIGH
Network based expected synthesizer latency (~200ms)
Constant Value: 400 (0x00000190)
LATENCY_LOW
public static final int LATENCY_LOW
Low expected synthesizer latency (~20ms)
Constant Value: 200 (0x000000c8)
LATENCY_NORMAL
public static final int LATENCY_NORMAL
Normal expected synthesizer latency (~50ms)
Constant Value: 300 (0x0000012c)
LATENCY_VERY_HIGH
public static final int LATENCY_VERY_HIGH
Very slow network based expected synthesizer latency (> 200ms)
Constant Value: 500 (0x000001f4)
LATENCY_VERY_LOW
public static final int LATENCY_VERY_LOW
Very low expected synthesizer latency (< 20ms)
Constant Value: 100 (0x00000064)
QUALITY_HIGH
public static final int QUALITY_HIGH
High, human-like quality of speech synthesis
Constant Value: 400 (0x00000190)
QUALITY_LOW
public static final int QUALITY_LOW
Low, not human-like quality of speech synthesis
Constant Value: 200 (0x000000c8)
QUALITY_NORMAL
public static final int QUALITY_NORMAL
Normal quality of speech synthesis
Constant Value: 300 (0x0000012c)
QUALITY_VERY_HIGH
public static final int QUALITY_VERY_HIGH
Very high, almost human-indistinguishable quality of speech synthesis
Constant Value: 500 (0x000001f4)
QUALITY_VERY_LOW
public static final int QUALITY_VERY_LOW
Very low, but still intelligible quality of speech synthesis
Constant Value: 100 (0x00000064)
Fields
Public constructors
Voice
public 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
public 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(android.os.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.
 Value is either 0orCONTENTS_FILE_DESCRIPTOR | 
equals
public 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 returntrue.
- It is symmetric: for any non-null reference values
     xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue.
- It is transitive: for any non-null reference values
     x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue.
- It is consistent: for any non-null reference values
     xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified.
- For any non-null reference value x,x.equals(null)should returnfalse.
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 | Object: This value may benull. | 
| Returns | |
|---|---|
| boolean | trueif this object is the same as the obj
          argument;falseotherwise. | 
getFeatures
public Set<String> getFeatures ()
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.
| Returns | |
|---|---|
| Set<String> | Set instance. May return nullon error. | 
getLatency
public int getLatency ()
| Returns | |
|---|---|
| int | The voice's latency (lower is better) | 
getQuality
public int getQuality ()
| Returns | |
|---|---|
| int | The voice's quality (higher is better) | 
hashCode
public 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 hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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 equalsmethod, then calling thehashCodemethod 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 equalsmethod, then calling thehashCodemethod 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.
| Returns | |
|---|---|
| int | a hash code value for this object. | 
isNetworkConnectionRequired
public boolean isNetworkConnectionRequired ()
| Returns | |
|---|---|
| boolean | Does the Voice require a network connection to work. | 
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
| String | a string representation of the object. | 
writeToParcel
public 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.
 This value cannot benull. | 
| flags | int: Additional flags about how the object should be written.
 May be 0 orParcelable.PARCELABLE_WRITE_RETURN_VALUE.
 Value is either0or a combination ofParcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES | 
