RecognitionPart


public final class RecognitionPart
extends Object implements Parcelable

java.lang.Object
   ↳ android.speech.RecognitionPart


Info about a single recognition part.

A recognition part represents a recognized word or character, as well as any potential adjacent punctuation, that is returned by the SpeechRecognizer.

Each recognition part is described with a String denoting the raw text. Additionally, if formatting is enabled with RecognizerIntent#EXTRA_ENABLE_FORMATTING, another String representation exists denoting the formatted text.

If the timestamps are requested with RecognizerIntent#EXTRA_REQUEST_WORD_TIMING, each recognition part will contain a value representing the offset of the beginning of this part from the start of the recognition session in milliseconds.

If the confidence levels are requested with RecognizerIntent#EXTRA_REQUEST_WORD_CONFIDENCE, each recognition part will contain a value describing the level of recognition confidence.

Summary

Nested classes

class RecognitionPart.Builder

A builder for RecognitionPart 

Constants

int CONFIDENCE_LEVEL_HIGH

Highest level of confidence out of five levels.

int CONFIDENCE_LEVEL_LOW

Lowest level of confidence out of five levels.

int CONFIDENCE_LEVEL_MEDIUM

Medium level of confidence out of five levels.

int CONFIDENCE_LEVEL_MEDIUM_HIGH

Second-highest level of confidence out of five levels.

int CONFIDENCE_LEVEL_MEDIUM_LOW

Second-lowest level of confidence out of five levels.

int CONFIDENCE_LEVEL_UNKNOWN

Confidence level not requested.

Inherited constants

Fields

public static final Creator<RecognitionPart> CREATOR

Public methods

int describeContents()

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

boolean equals(Object o)

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

int getConfidenceLevel()

The level of confidence for this part if requested with RecognizerIntent#EXTRA_REQUEST_WORD_CONFIDENCE.

String getFormattedText()

The formatted text version of the recognized part of the result.

String getRawText()

The non-null raw text version of the recognized part of the result.

long getTimestampMillis()

Non-negative offset of the beginning of this part from the start of the recognition session in milliseconds if requested with RecognizerIntent#EXTRA_REQUEST_WORD_TIMING.

int hashCode()

Returns a hash code value for the object.

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

CONFIDENCE_LEVEL_HIGH

Added in API level 34
public static final int CONFIDENCE_LEVEL_HIGH

Highest level of confidence out of five levels.

Constant Value: 5 (0x00000005)

CONFIDENCE_LEVEL_LOW

Added in API level 34
public static final int CONFIDENCE_LEVEL_LOW

Lowest level of confidence out of five levels.

Constant Value: 1 (0x00000001)

CONFIDENCE_LEVEL_MEDIUM

Added in API level 34
public static final int CONFIDENCE_LEVEL_MEDIUM

Medium level of confidence out of five levels.

Constant Value: 3 (0x00000003)

CONFIDENCE_LEVEL_MEDIUM_HIGH

Added in API level 34
public static final int CONFIDENCE_LEVEL_MEDIUM_HIGH

Second-highest level of confidence out of five levels.

Constant Value: 4 (0x00000004)

CONFIDENCE_LEVEL_MEDIUM_LOW

Added in API level 34
public static final int CONFIDENCE_LEVEL_MEDIUM_LOW

Second-lowest level of confidence out of five levels.

Constant Value: 2 (0x00000002)

CONFIDENCE_LEVEL_UNKNOWN

Added in API level 34
public static final int CONFIDENCE_LEVEL_UNKNOWN

Confidence level not requested.

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 34
public static final Creator<RecognitionPart> CREATOR

Public methods

describeContents

Added in API level 34
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 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 34
public boolean equals (Object o)

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
o Object: This value may be null.

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

getConfidenceLevel

Added in API level 34
public int getConfidenceLevel ()

The level of confidence for this part if requested with RecognizerIntent#EXTRA_REQUEST_WORD_CONFIDENCE.

Otherwise, this should equal CONFIDENCE_LEVEL_UNKNOWN.

Returns
int Value is CONFIDENCE_LEVEL_UNKNOWN, CONFIDENCE_LEVEL_LOW, CONFIDENCE_LEVEL_MEDIUM_LOW, CONFIDENCE_LEVEL_MEDIUM, CONFIDENCE_LEVEL_MEDIUM_HIGH, or CONFIDENCE_LEVEL_HIGH

getFormattedText

Added in API level 34
public String getFormattedText ()

The formatted text version of the recognized part of the result. If formatting is enabled with RecognizerIntent#EXTRA_ENABLE_FORMATTING, it has a non-null value.

Otherwise, it should be null by default.

Returns
String

getRawText

Added in API level 34
public String getRawText ()

The non-null raw text version of the recognized part of the result.

Returns
String

getTimestampMillis

Added in API level 34
public long getTimestampMillis ()

Non-negative offset of the beginning of this part from the start of the recognition session in milliseconds if requested with RecognizerIntent#EXTRA_REQUEST_WORD_TIMING.

Otherwise, this should equal 0.

Returns
long

hashCode

Added in API level 34
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 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.

Returns
int a hash code value for this object.

toString

Added in API level 34
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 34
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES