Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/media/RouteListingPreference#nestedclasses) \| [Constants](https://developer.android.com/reference/android/media/RouteListingPreference#constants) \| [Inherited Constants](https://developer.android.com/reference/android/media/RouteListingPreference#inhconstants) \| [Fields](https://developer.android.com/reference/android/media/RouteListingPreference#lfields) \| [Methods](https://developer.android.com/reference/android/media/RouteListingPreference#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/RouteListingPreference#inhmethods)

# RouteListingPreference

*** ** * ** ***


`
public

final

class
RouteListingPreference
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/android/os/Parcelable


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.media.RouteListingPreference |

<br />

*** ** * ** ***

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

- `https://developer.android.com/reference/android/media/MediaRouter2#setRouteListingPreference(android.media.RouteListingPreference)`
- `https://developer.android.com/reference/android/media/RouteListingPreference.Item`

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/media/RouteListingPreference.Builder` Builder for `https://developer.android.com/reference/android/media/RouteListingPreference`. |
| ` class` | `https://developer.android.com/reference/android/media/RouteListingPreference.Item` Holds preference information for a specific route in a `https://developer.android.com/reference/android/media/RouteListingPreference`. |

| ### Constants ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/media/RouteListingPreference#ACTION_RESOLVE_MISSING_PERMISSIONS` `https://developer.android.com/reference/android/content/Intent` action for apps to handle issues with missing permissions. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/media/RouteListingPreference#ACTION_TRANSFER_MEDIA` `https://developer.android.com/reference/android/content/Intent` action that the system uses to take the user the app when the user selects an `https://developer.android.com/reference/android/media/RouteListingPreference.Item` whose `https://developer.android.com/reference/android/media/RouteListingPreference.Item#getSelectionBehavior()` is `https://developer.android.com/reference/android/media/RouteListingPreference.Item#SELECTION_BEHAVIOR_GO_TO_APP`. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/media/RouteListingPreference#EXTRA_MISSING_PERMISSIONS` `https://developer.android.com/reference/android/content/Intent` string extra key that contains missing permissions. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/media/RouteListingPreference#EXTRA_ROUTE_ID` `https://developer.android.com/reference/android/content/Intent` string extra key that contains the `https://developer.android.com/reference/android/media/RouteListingPreference.Item#getRouteId()` of the route to transfer to, as part of an `https://developer.android.com/reference/android/media/RouteListingPreference#ACTION_TRANSFER_MEDIA` intent. |

| ### Inherited constants |
|---|
| From interface `https://developer.android.com/reference/android/os/Parcelable` |---|---| | `int` | `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`". | |

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/media/RouteListingPreference>` | `https://developer.android.com/reference/android/media/RouteListingPreference#CREATOR` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/media/RouteListingPreference#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/media/RouteListingPreference#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object other) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/media/RouteListingPreference.Item>` | ` https://developer.android.com/reference/android/media/RouteListingPreference#getItems()() ` Returns an unmodifiable list containing the `https://developer.android.com/reference/android/media/RouteListingPreference.Item` that the app wants to be listed for media routing. |
| ` https://developer.android.com/reference/android/content/ComponentName` | ` https://developer.android.com/reference/android/media/RouteListingPreference#getLinkedItemComponentName()() ` Returns a `https://developer.android.com/reference/android/content/ComponentName` for navigating to the application. |
| ` https://developer.android.com/reference/android/content/ComponentName` | ` https://developer.android.com/reference/android/media/RouteListingPreference#getMissingPermissionsComponentName()() ` Returns a `https://developer.android.com/reference/android/content/ComponentName` for navigating to the application to fix missing permissions. |
| ` boolean` | ` https://developer.android.com/reference/android/media/RouteListingPreference#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 `https://developer.android.com/reference/android/media/RouteListingPreference#getItems()`. |
| ` int` | ` https://developer.android.com/reference/android/media/RouteListingPreference#hashCode()() ` Returns a hash code value for the object. |
| ` void` | ` https://developer.android.com/reference/android/media/RouteListingPreference#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
| From interface ` https://developer.android.com/reference/android/os/Parcelable ` |---|---| | ` abstract int` | ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. | ||

## Constants

### ACTION_RESOLVE_MISSING_PERMISSIONS

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ACTION_RESOLVE_MISSING_PERMISSIONS
```

`https://developer.android.com/reference/android/content/Intent` action for apps to handle issues with missing permissions.

The system uses this action to take the user to the app when a
`https://developer.android.com/reference/android/media/RouteDiscoveryPreference` set by the app cannot be satisfied due to missing
permissions, and the user has triggered a UI flow to fix the issue.

The launched intent will identify the missing permissions using the extra identified by
`https://developer.android.com/reference/android/media/RouteListingPreference#EXTRA_MISSING_PERMISSIONS`.

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RouteListingPreference#getMissingPermissionsComponentName()`

Constant Value:

"android.media.action.RESOLVE_MISSING_PERMISSIONS"


### ACTION_TRANSFER_MEDIA

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ACTION_TRANSFER_MEDIA
```

`https://developer.android.com/reference/android/content/Intent` action that the system uses to take the user the app when the user selects an
`https://developer.android.com/reference/android/media/RouteListingPreference.Item` whose `https://developer.android.com/reference/android/media/RouteListingPreference.Item#getSelectionBehavior()` is `https://developer.android.com/reference/android/media/RouteListingPreference.Item#SELECTION_BEHAVIOR_GO_TO_APP`.

The launched intent will identify the selected item using the extra identified by `https://developer.android.com/reference/android/media/RouteListingPreference#EXTRA_ROUTE_ID`.

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RouteListingPreference#getLinkedItemComponentName()`
- `https://developer.android.com/reference/android/media/RouteListingPreference.Item#SELECTION_BEHAVIOR_GO_TO_APP`

Constant Value:

"android.media.action.TRANSFER_MEDIA"


### EXTRA_MISSING_PERMISSIONS

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String EXTRA_MISSING_PERMISSIONS
```

`https://developer.android.com/reference/android/content/Intent` string extra key that contains missing permissions.

This is part of an `https://developer.android.com/reference/android/media/RouteListingPreference#ACTION_RESOLVE_MISSING_PERMISSIONS` intent. The value can be
obtained through `https://developer.android.com/reference/android/content/Intent#getStringArrayListExtra(java.lang.String)`. It is the list of
permissions which the app has requested in its AndroidManifest.xml but were not granted, and
are part of the required permissions for some routes.

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RouteListingPreference#getMissingPermissionsComponentName()`

Constant Value:

"android.media.extra.MISSING_PERMISSIONS"


### EXTRA_ROUTE_ID

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String EXTRA_ROUTE_ID
```

`https://developer.android.com/reference/android/content/Intent` string extra key that contains the `https://developer.android.com/reference/android/media/RouteListingPreference.Item#getRouteId()` of the route
to transfer to, as part of an `https://developer.android.com/reference/android/media/RouteListingPreference#ACTION_TRANSFER_MEDIA` intent.

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RouteListingPreference#getLinkedItemComponentName()`
- `https://developer.android.com/reference/android/media/RouteListingPreference.Item#SELECTION_BEHAVIOR_GO_TO_APP`

Constant Value:

"android.media.extra.ROUTE_ID"


## Fields

### CREATOR

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<RouteListingPreference> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### equals

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

| Parameters ||
|---|---|
| `other` | `Object`: the reference object with which to compare. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getItems

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public List<RouteListingPreference.Item> getItems ()
```

Returns an unmodifiable list containing the `https://developer.android.com/reference/android/media/RouteListingPreference.Item` that the app wants to be
listed for media routing.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/media/RouteListingPreference.Item>` | This value cannot be `null`. <br /> |

### getLinkedItemComponentName

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public ComponentName getLinkedItemComponentName ()
```

Returns a `https://developer.android.com/reference/android/content/ComponentName` for navigating to the application.

Must not be null if any of the `https://developer.android.com/reference/android/media/RouteListingPreference#getItems()` of this route listing preference
has `https://developer.android.com/reference/android/media/RouteListingPreference.Item#getSelectionBehavior()` `https://developer.android.com/reference/android/media/RouteListingPreference.Item#SELECTION_BEHAVIOR_GO_TO_APP`.

The system navigates to the application when the user selects `https://developer.android.com/reference/android/media/RouteListingPreference.Item` with `https://developer.android.com/reference/android/media/RouteListingPreference.Item#SELECTION_BEHAVIOR_GO_TO_APP` by launching an intent to the returned `https://developer.android.com/reference/android/content/ComponentName`, using action `https://developer.android.com/reference/android/media/RouteListingPreference#ACTION_TRANSFER_MEDIA`, with the extra `https://developer.android.com/reference/android/media/RouteListingPreference#EXTRA_ROUTE_ID`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/content/ComponentName` | <br /> |

### getMissingPermissionsComponentName

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public ComponentName getMissingPermissionsComponentName ()
```

Returns a `https://developer.android.com/reference/android/content/ComponentName` for navigating to the application to fix missing permissions.

The system navigates to the application when a route discovery preference set by the app
cannot be satisfied due to missing permissions, and the user has triggered a UI flow to fix
the issue.

The system launches an intent to the returned `https://developer.android.com/reference/android/content/ComponentName`, using action
`https://developer.android.com/reference/android/media/RouteListingPreference#ACTION_RESOLVE_MISSING_PERMISSIONS`, with the extra
`https://developer.android.com/reference/android/media/RouteListingPreference#EXTRA_MISSING_PERMISSIONS`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/content/ComponentName` | This value may be `null`. <br /> |

### getUseSystemOrdering

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/media/RouteListingPreference#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.

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### hashCode

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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
`https://developer.android.com/reference/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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### writeToParcel

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |