RouteListingPreference
class RouteListingPreference : Parcelable
| kotlin.Any | |
| ↳ | 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 | |
|---|---|
|
Builder for |
|
|
Holds preference information for a specific route in a |
|
| Constants | |
|---|---|
| static String |
|
| static String |
|
| 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. |
| MutableList<RouteListingPreference.Item!> |
getItems()Returns an unmodifiable list containing the |
| ComponentName? |
Returns a |
| Boolean |
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 |
| Int |
hashCode()Returns a hash code value for the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<RouteListingPreference!> | |
Constants
ACTION_TRANSFER_MEDIA
static val ACTION_TRANSFER_MEDIA: String
Intent action that the system uses to take the user the app when the user selects an Item whose selection behavior is Item.SELECTION_BEHAVIOR_GO_TO_APP.
The launched intent will identify the selected item using the extra identified by EXTRA_ROUTE_ID.
Value: "android.media.action.TRANSFER_MEDIA"EXTRA_ROUTE_ID
static val EXTRA_ROUTE_ID: String
Intent string extra key that contains the id of the route to transfer to, as part of an ACTION_TRANSFER_MEDIA intent.
Value: "android.media.extra.ROUTE_ID"Public 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. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getItems
fun getItems(): MutableList<RouteListingPreference.Item!>
Returns an unmodifiable list containing the items that the app wants to be listed for media routing.
| Return | |
|---|---|
MutableList<RouteListingPreference.Item!> |
This value cannot be null. |
getLinkedItemComponentName
fun getLinkedItemComponentName(): ComponentName?
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 Item.SELECTION_BEHAVIOR_GO_TO_APP.
The system navigates to the application when the user selects Item with 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.
getUseSystemOrdering
fun getUseSystemOrdering(): Boolean
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.
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. |
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:
|