MediaRouteProvider.RouteController


abstract class MediaRouteProvider.RouteController

Known direct subclasses
MediaRouteProvider.DynamicGroupRouteController

Provides control over a dynamic group route.


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

Public functions

Boolean
onControlRequest(
    intent: Intent,
    callback: MediaRouter.ControlRequestCallback?
)

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

Unit

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

Unit

Selects the route.

Unit
onSetVolume(volume: Int)

Requests to set the volume of the route.

Unit

This function is deprecated.

Use onUnselect instead.

Unit
onUnselect(reason: Int)

Unselects the route and provides a reason.

Unit

Requests an incremental volume update for the route.

Public constructors

RouteController

Added in 1.1.0
RouteController()

Public functions

onControlRequest

Added in 1.1.0
fun onControlRequest(
    intent: Intent,
    callback: MediaRouter.ControlRequestCallback?
): Boolean

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

Parameters
intent: Intent

A media control intent.

callback: MediaRouter.ControlRequestCallback?

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

onRelease

Added in 1.1.0
fun onRelease(): Unit

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

onSelect

Added in 1.1.0
fun onSelect(): Unit

Selects the route.

onSetVolume

Added in 1.1.0
fun onSetVolume(volume: Int): Unit

Requests to set the volume of the route.

Parameters
volume: Int

The new volume value between 0 and getVolumeMax.

onUnselect

Added in 1.1.0
Deprecated in 1.2.0
fun onUnselect(): Unit

Unselects the route.

onUnselect

Added in 1.1.0
fun onUnselect(reason: Int): Unit

Unselects the route and provides a reason. The default implementation calls onUnselect.

The reason provided will be one of the following:

Parameters
reason: Int

The reason for unselecting the route.

onUpdateVolume

Added in 1.1.0
fun onUpdateVolume(delta: Int): Unit

Requests an incremental volume update for the route.

Parameters
delta: Int

The delta to add to the current volume.