Added in API level 34

AlternativeSpan

class AlternativeSpan : Parcelable
kotlin.Any
   ↳ android.speech.AlternativeSpan

List of alternative hypotheses for a specific span of a speech recognition result string.

A single SpeechRecognizer result is represented as a String. For a specific span of the originally recognized result string, the recognizer may provide alternative hypotheses of what it may have recognized. A span is specifically a substring and is thereby defined by its start and end positions in the originally recognized string. Alternative hypotheses are represented as strings which may replace that substring.

These alternatives can be used to enhance recognition by adding/re-ranking/applying or in other ways manipulating the SpeechRecognizer results before powering dictation features.

Summary

Inherited constants
Public constructors
AlternativeSpan(startPosition: Int, endPosition: Int, alternatives: MutableList<String!>)

Creates a new AlternativeSpan.
Public methods
Int

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
MutableList<String!>

All the alternatives for the [mStart, mEnd) span.
Int

The exclusive end position of the span of the originally recognized string.
Int

The start position of the span of the originally recognized string.
Int

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<AlternativeSpan!>

Public constructors

AlternativeSpan

Added in API level 34
AlternativeSpan(
    startPosition: Int, 
    endPosition: Int, 
    alternatives: MutableList<String!>)

Creates a new AlternativeSpan.

Parameters
startPosition Int: The start position of the span of the originally recognized string.

Must be set to a non-negative value before building.
endPosition Int: The exclusive end position of the span of the originally recognized string.

Must be set to a value greater than the start of the span before building.
alternatives MutableList<String!>: All the alternatives for the [mStart, mEnd) span.

Must not be empty. The object will only be created if there are some alternatives for the given span.

The alternatives may be strings of different lengths than the span they can replace. This value cannot be null.

Public methods

describeContents

Added in API level 34
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

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

getAlternatives

Added in API level 34
fun getAlternatives(): MutableList<String!>

All the alternatives for the [mStart, mEnd) span.

Must not be empty. The object will only be created if there are some alternatives for the given span.

The alternatives may be strings of different lengths than the span they can replace.

Return
MutableList<String!> This value cannot be null.

getEndPosition

Added in API level 34
fun getEndPosition(): Int

The exclusive end position of the span of the originally recognized string.

Must be set to a value greater than the start of the span before building.

getStartPosition

Added in API level 34
fun getStartPosition(): Int

The start position of the span of the originally recognized string.

Must be set to a non-negative value before building.

hashCode

Added in API level 34
fun hashCode(): Int
Return
Int a hash code value for this object.

toString

Added in API level 34
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 34
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 android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 34
static val CREATOR: Parcelable.Creator<AlternativeSpan!>