RecognitionPart
class RecognitionPart : Parcelable
| kotlin.Any | |
| ↳ | 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 | |
|---|---|
|
A builder for |
|
| Constants | |
|---|---|
| static Int |
Highest level of confidence out of five levels. |
| static Int |
Lowest level of confidence out of five levels. |
| static Int |
Medium level of confidence out of five levels. |
| static Int |
Second-highest level of confidence out of five levels. |
| static Int |
Second-lowest level of confidence out of five levels. |
| static Int |
Confidence level not requested. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Int |
The level of confidence for this part if requested with |
| String? |
The formatted text version of the recognized part of the result. |
| String |
The |
| Long |
Non-negative offset of the beginning of this part from the start of the recognition session in milliseconds if requested with |
| Int |
hashCode()Returns a hash code value for the object. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<RecognitionPart!> | |
Constants
CONFIDENCE_LEVEL_HIGH
static val CONFIDENCE_LEVEL_HIGH: Int
Highest level of confidence out of five levels.
Value: 5CONFIDENCE_LEVEL_LOW
static val CONFIDENCE_LEVEL_LOW: Int
Lowest level of confidence out of five levels.
Value: 1CONFIDENCE_LEVEL_MEDIUM
static val CONFIDENCE_LEVEL_MEDIUM: Int
Medium level of confidence out of five levels.
Value: 3CONFIDENCE_LEVEL_MEDIUM_HIGH
static val CONFIDENCE_LEVEL_MEDIUM_HIGH: Int
Second-highest level of confidence out of five levels.
Value: 4CONFIDENCE_LEVEL_MEDIUM_LOW
static val CONFIDENCE_LEVEL_MEDIUM_LOW: Int
Second-lowest level of confidence out of five levels.
Value: 2CONFIDENCE_LEVEL_UNKNOWN
static val CONFIDENCE_LEVEL_UNKNOWN: Int
Confidence level not requested.
Value: 0Public methods
describeContents
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
|
equals
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 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 |
the reference object with which to compare. |
o |
This value may be null. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getConfidenceLevel
fun getConfidenceLevel(): Int
The level of confidence for this part if requested with RecognizerIntent.EXTRA_REQUEST_WORD_CONFIDENCE.
Otherwise, this should equal CONFIDENCE_LEVEL_UNKNOWN.
| Return | |
|---|---|
Int |
Value is one of the following: |
getFormattedText
fun getFormattedText(): String?
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.
getRawText
fun getRawText(): String
The non-null raw text version of the recognized part of the result.
getTimestampMillis
fun getTimestampMillis(): Long
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.
hashCode
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
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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|