Item

FLAG_ONGOING_SESSION

static val FLAG_ONGOING_SESSION: Int

The corresponding route is already hosting a session with the app that owns this listing preference.

Value: 1

FLAG_ONGOING_SESSION_MANAGED

static val FLAG_ONGOING_SESSION_MANAGED: Int

Signals that the ongoing session on the corresponding route is managed by the current user of the app.

The system can use this flag to provide visual indication that the route is not only hosting a session, but also that the user has ownership over said session.

This flag is ignored if FLAG_ONGOING_SESSION is not set, or if the corresponding route is not currently selected.

This flag does not affect volume adjustment (see VolumeProvider, and MediaRoute2Info.getVolumeHandling()), or any aspect other than the visual representation of the corresponding item.

Value: 2

FLAG_SUGGESTED

static val FLAG_SUGGESTED: Int

The corresponding route is specially likely to be selected by the user.

A UI reflecting this preference may reserve a specific space for suggested routes, making it more accessible to the user. If the number of suggested routes exceeds the number supported by the UI, the routes listed first in RouteListingPreference.getItems() will take priority.

Value: 4

SELECTION_BEHAVIOR_GO_TO_APP

static val SELECTION_BEHAVIOR_GO_TO_APP: Int

If the user selects the corresponding route, the system takes the user to the application.

The system uses getLinkedItemComponentName() in order to navigate to the app.

Value: 2

SELECTION_BEHAVIOR_NONE

static val SELECTION_BEHAVIOR_NONE: Int

The corresponding route is not selectable by the user.

Value: 0

SELECTION_BEHAVIOR_TRANSFER

static val SELECTION_BEHAVIOR_TRANSFER: Int

If the user selects the corresponding route, the media transfers to the said route.

Value: 1

SUBTEXT_AD_ROUTING_DISALLOWED

static val SUBTEXT_AD_ROUTING_DISALLOWED: Int

The corresponding route's subtext must indicate that it is not available because an ad is in progress.

Value: 4

SUBTEXT_CUSTOM

static val SUBTEXT_CUSTOM: Int

The corresponding route's subtext must be obtained from getCustomSubtextMessage().

Applications should strongly prefer one of the other disable reasons (for the full list, see getSubText()) in order to guarantee correct localization and rendering across all form factors.

Value: 10000

SUBTEXT_DEVICE_LOW_POWER

static val SUBTEXT_DEVICE_LOW_POWER: Int

The corresponding route's subtext must indicate that it is not available because the device is in low-power mode.

Value: 5

SUBTEXT_DOWNLOADED_CONTENT_ROUTING_DISALLOWED

static val SUBTEXT_DOWNLOADED_CONTENT_ROUTING_DISALLOWED: Int

The corresponding route's subtext must indicate that downloaded content cannot be routed to it.

Value: 3

SUBTEXT_ERROR_UNKNOWN

static val SUBTEXT_ERROR_UNKNOWN: Int

The corresponding route's subtext must indicate that it is not available because of an unknown error.

Value: 1

SUBTEXT_NONE

static val SUBTEXT_NONE: Int

The corresponding route has no associated subtext.

Value: 0

SUBTEXT_SUBSCRIPTION_REQUIRED

static val SUBTEXT_SUBSCRIPTION_REQUIRED: Int

The corresponding route's subtext must indicate that it requires a special subscription in order to be available for routing.

Value: 2

SUBTEXT_TRACK_UNSUPPORTED

static val SUBTEXT_TRACK_UNSUPPORTED: Int

The corresponding route's subtext must indicate that it is not available because the device does not support the current media track.

Value: 7

SUBTEXT_UNAUTHORIZED

static val SUBTEXT_UNAUTHORIZED: Int

The corresponding route's subtext must indicate that it is not available because the user is not authorized to route to it.

Value: 6

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.

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 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.

getCustomSubtextMessage

fun getCustomSubtextMessage(): CharSequence?

Returns a human-readable CharSequence providing the subtext for the corresponding route.

This value is ignored if the subtext for this item is not SUBTEXT_CUSTOM..

Applications must provide a localized message that matches the system's locale. See Locale.getDefault().

Applications should avoid using custom messages (and instead use one of non-custom subtexts listed in getSubText() in order to guarantee correct visual representation and localization on all form factors.

getFlags

fun getFlags(): Int

Returns the flags associated to the route that corresponds to this item.

getRouteId

fun getRouteId(): String

Returns the id of the route that corresponds to this route listing preference item.

getSelectionBehavior

fun getSelectionBehavior(): Int

Returns the behavior that the corresponding route has if the user selects it.

getSubText

fun getSubText(): Int

Returns the type of subtext associated to this route.

Subtext types other than SUBTEXT_NONE and SUBTEXT_CUSTOM must not have SELECTION_BEHAVIOR_TRANSFER.

If this method returns SUBTEXT_CUSTOM, then the subtext is obtained form getCustomSubtextMessage().

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 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.

toString

fun toString(): String

Returns a string representation of the object.

writeToParcel

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

Flatten this object in to a Parcel.

CREATOR

static val CREATOR: Parcelable.Creator<RouteListingPreference.Item!>