belongs to Maven artifact com.android.support:mediarouter-v7:28.0.0-alpha1
MediaRouteProvider.RouteController
public
static
abstract
class
MediaRouteProvider.RouteController
extends Object
java.lang.Object | |
↳ | android.support.v7.media.MediaRouteProvider.RouteController |
Provides control over a particular route.
The media router obtains a route controller for a route whenever it needs
to control a route. When a route is selected, the media router invokes
the onSelect()
method of its route controller. While selected,
the media router may call other methods of the route controller to
request that it perform certain actions to the route. When a route is
unselected, the media router invokes the onUnselect()
method of its
route controller. When the media route no longer needs the route controller
it will invoke the onRelease()
method to allow the route controller
to free its resources.
There may be multiple route controllers simultaneously active for the same route. Each route controller will be released separately.
All operations on the route controller are asynchronous and results are communicated via callbacks.
Summary
Public constructors | |
---|---|
MediaRouteProvider.RouteController()
|
Public methods | |
---|---|
boolean
|
onControlRequest(Intent intent, MediaRouter.ControlRequestCallback callback)
Performs a |
void
|
onRelease()
Releases the route controller, allowing it to free its resources. |
void
|
onSelect()
Selects the route. |
void
|
onSetVolume(int volume)
Requests to set the volume of the route. |
void
|
onUnselect()
Unselects the route. |
void
|
onUnselect(int reason)
Unselects the route and provides a reason. |
void
|
onUpdateVolume(int delta)
Requests an incremental volume update for the route. |
Inherited methods | |
---|---|
From
class
java.lang.Object
|
Public constructors
Public methods
onControlRequest
boolean onControlRequest (Intent intent, MediaRouter.ControlRequestCallback callback)
Performs a media control
request
asynchronously on behalf of the route.
Parameters | |
---|---|
intent |
Intent : A media control intent . |
callback |
MediaRouter.ControlRequestCallback : A MediaRouter.ControlRequestCallback to invoke with the result
of the request, or null if no result is required. |
Returns | |
---|---|
boolean |
True if the controller intends to handle the request and will invoke the callback when finished. False if the controller will not handle the request and will not invoke the callback. |
See also:
onRelease
void onRelease ()
Releases the route controller, allowing it to free its resources.
onSetVolume
void onSetVolume (int volume)
Requests to set the volume of the route.
Parameters | |
---|---|
volume |
int : The new volume value between 0 and getVolumeMax() .
|
onUnselect
void onUnselect (int reason)
Unselects the route and provides a reason. The default implementation
calls onUnselect()
.
The reason provided will be one of the following:
UNSELECT_REASON_UNKNOWN
UNSELECT_REASON_DISCONNECTED
UNSELECT_REASON_STOPPED
UNSELECT_REASON_ROUTE_CHANGED
Parameters | |
---|---|
reason |
int : The reason for unselecting the route.
|
onUpdateVolume
void onUpdateVolume (int delta)
Requests an incremental volume update for the route.
Parameters | |
---|---|
delta |
int : The delta to add to the current volume.
|
Interfaces
Classes
- MediaControlIntent
- MediaItemMetadata
- MediaItemStatus
- MediaItemStatus.Builder
- MediaRouteDescriptor
- MediaRouteDescriptor.Builder
- MediaRouteDiscoveryRequest
- MediaRouteProvider
- MediaRouteProvider.Callback
- MediaRouteProvider.ProviderMetadata
- MediaRouteProvider.RouteController
- MediaRouteProviderDescriptor
- MediaRouteProviderDescriptor.Builder
- MediaRouteProviderService
- MediaRouter
- MediaRouter.Callback
- MediaRouter.ControlRequestCallback
- MediaRouter.ProviderInfo
- MediaRouter.RouteInfo
- MediaRouteSelector
- MediaRouteSelector.Builder
- MediaSessionStatus
- MediaSessionStatus.Builder
- RemotePlaybackClient
- RemotePlaybackClient.ActionCallback
- RemotePlaybackClient.ItemActionCallback
- RemotePlaybackClient.SessionActionCallback
- RemotePlaybackClient.StatusCallback