to top
Android APIs
public static abstract class

MediaRouteProvider.RouteController

extends Object
java.lang.Object
   ↳ android.support.v7.media.MediaRouteProvider.RouteController

Class Overview

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 media control request asynchronously on behalf of the route.
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 onUpdateVolume(int delta)
Requests an incremental volume update for the route.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MediaRouteProvider.RouteController ()

Public Methods

public boolean onControlRequest (Intent intent, MediaRouter.ControlRequestCallback callback)

Performs a media control request asynchronously on behalf of the route.

Parameters
intent A media control intent.
callback A MediaRouter.ControlRequestCallback to invoke with the result of the request, or null if no result is required.
Returns
  • 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.

public void onRelease ()

Releases the route controller, allowing it to free its resources.

public void onSelect ()

Selects the route.

public void onSetVolume (int volume)

Requests to set the volume of the route.

Parameters
volume The new volume value between 0 and getVolumeMax().

public void onUnselect ()

Unselects the route.

public void onUpdateVolume (int delta)

Requests an incremental volume update for the route.

Parameters
delta The delta to add to the current volume.