RouteListingPreference
class RouteListingPreference
Allows applications to customize the list of routes used for media routing (for example, in the System UI Output Switcher).
Summary
Nested types |
|---|
|
Builder for |
|
Holds preference information for a specific route in a |
|
Builder for |
Constants |
|
|---|---|
const String! |
ACTION_TRANSFER_MEDIA = "android.media.action.TRANSFER_MEDIA"
|
const String! |
EXTRA_ROUTE_ID = "android.media.extra.ROUTE_ID"
|
Public functions |
|
|---|---|
Boolean |
|
(Mutable)List<RouteListingPreference.Item!> |
getItems()Returns an unmodifiable list containing the |
ComponentName? |
Returns a |
Int |
hashCode() |
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 |
Constants
ACTION_TRANSFER_MEDIA
const val ACTION_TRANSFER_MEDIA = "android.media.action.TRANSFER_MEDIA": String!
Intent action that the system uses to take the user the app when the user selects an RouteListingPreference.Item whose selection behavior is SELECTION_BEHAVIOR_GO_TO_APP.
The launched intent will identify the selected item using the extra identified by EXTRA_ROUTE_ID.
EXTRA_ROUTE_ID
const val EXTRA_ROUTE_ID = "android.media.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.
Public functions
getItems
fun getItems(): (Mutable)List<RouteListingPreference.Item!>
Returns an unmodifiable list containing the items that the app wants to be listed for media routing.
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 behaviorSELECTION_BEHAVIOR_GO_TO_APP.
The system navigates to the application when the user selects RouteListingPreference.Item with SELECTION_BEHAVIOR_GO_TO_APP by launching an intent to the returned ComponentName, using action ACTION_TRANSFER_MEDIA, with the extra EXTRA_ROUTE_ID.
isSystemOrderingEnabled
fun isSystemOrderingEnabled(): 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.