RouteListingPreference


public final class RouteListingPreference
extends Object implements Parcelable

java.lang.Object
   ↳ android.media.RouteListingPreference


Allows applications to customize the list of routes used for media routing (for example, in the System UI Output Switcher).

Summary

Nested classes

class RouteListingPreference.Builder

Builder for RouteListingPreference

class RouteListingPreference.Item

Holds preference information for a specific route in a RouteListingPreference

Constants

String ACTION_TRANSFER_MEDIA

Intent action that the system uses to take the user the app when the user selects an Item whose selection behavior is RouteListingPreference.Item.SELECTION_BEHAVIOR_GO_TO_APP.

String EXTRA_ROUTE_ID

Intent string extra key that contains the id of the route to transfer to, as part of an ACTION_TRANSFER_MEDIA intent.

Inherited constants

Fields

public static final Creator<RouteListingPreference> CREATOR

Public methods

int describeContents()

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

boolean equals(Object other)

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

List<RouteListingPreference.Item> getItems()

Returns an unmodifiable list containing the items that the app wants to be listed for media routing.

ComponentName getLinkedItemComponentName()

Returns a ComponentName for navigating to the application.

boolean getUseSystemOrdering()

Returns true if the application would like media route listing to use the system's ordering strategy, or false if the application would like route listing to respect the ordering obtained from getItems().

int hashCode()

Returns a hash code value for the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

ACTION_TRANSFER_MEDIA

Added in API level 34
public static final String ACTION_TRANSFER_MEDIA

Intent action that the system uses to take the user the app when the user selects an Item whose selection behavior is RouteListingPreference.Item.SELECTION_BEHAVIOR_GO_TO_APP.

The launched intent will identify the selected item using the extra identified by EXTRA_ROUTE_ID.

Constant Value: "android.media.action.TRANSFER_MEDIA"

EXTRA_ROUTE_ID

Added in API level 34
public static final String EXTRA_ROUTE_ID

Intent string extra key that contains the id of the route to transfer to, as part of an ACTION_TRANSFER_MEDIA intent.

Constant Value: "android.media.extra.ROUTE_ID"

Fields

CREATOR

Added in API level 34
public static final Creator<RouteListingPreference> 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 other)

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
other Object: the reference object with which to compare.

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

getItems

Added in API level 34
public List<RouteListingPreference.Item> getItems ()

Returns an unmodifiable list containing the items that the app wants to be listed for media routing.

Returns
List<RouteListingPreference.Item> This value cannot be null.

getLinkedItemComponentName

Added in API level 34
public ComponentName getLinkedItemComponentName ()

Returns a ComponentName for navigating to the application.

Must not be null if any of the items of this route listing preference has selection behavior RouteListingPreference.Item.SELECTION_BEHAVIOR_GO_TO_APP.

The system navigates to the application when the user selects Item with RouteListingPreference.Item.SELECTION_BEHAVIOR_GO_TO_APP by launching an intent to the returned ComponentName, using action ACTION_TRANSFER_MEDIA, with the extra EXTRA_ROUTE_ID.

Returns
ComponentName

getUseSystemOrdering

Added in API level 34
public boolean getUseSystemOrdering ()

Returns true if the application would like media route listing to use the system's ordering strategy, or false if the application would like route listing to respect the ordering obtained from getItems().

The system's ordering strategy is implementation-dependent, but may take into account each route's recency or frequency of use in order to rank them.

Returns
boolean

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.

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