MediaRouter

Kotlin |Java

class MediaRouter

kotlin.Any
↳	androidx.mediarouter.media.MediaRouter

MediaRouter allows applications to control the routing of media channels and streams from the current device to external speakers and destination devices.

A MediaRouter instance is retrieved through getInstance. Applications can query the media router about the currently selected route and its capabilities to determine how to send content to the route's destination. Applications can also send control requests to the route to ask the route's destination to perform certain remote control functions such as playing media.

See also MediaRouteProvider for information on how an application can publish new media routes to the media router.

The media router API is not thread-safe; all interactions with it must be done from the main thread of the process.

Summary

Nested classes
abstract	`Callback` Interface for receiving events about media routing changes.
abstract	`ControlRequestCallback` Callback which is invoked with the result of a media control request.
abstract	`OnPrepareTransferListener` Listener for receiving events when the selected route is about to be changed.
	`ProviderInfo` Provides information about a media route provider.
	`RouteInfo` Provides information about a media route.

Constants
static Int	`AVAILABILITY_FLAG_IGNORE_DEFAULT_ROUTE` Flag for `isRouteAvailable`: Ignore the default route.
static Int	`AVAILABILITY_FLAG_REQUIRE_MATCH` Flag for `isRouteAvailable`: Require an actual route to be matched.
static Int	`CALLBACK_FLAG_FORCE_DISCOVERY` Flag for #addCallback: Request passive route discovery while this callback is registered, even on `low-RAM devices`.
static Int	`CALLBACK_FLAG_PERFORM_ACTIVE_SCAN` Flag for #addCallback: Actively scan for routes while this callback is registered.
static Int	`CALLBACK_FLAG_REQUEST_DISCOVERY` Flag for #addCallback: Request passive route discovery while this callback is registered, except on `low-RAM devices`.
static Int	`CALLBACK_FLAG_UNFILTERED_EVENTS` Flag for #addCallback: Do not filter route events.
static Int	`UNSELECT_REASON_DISCONNECTED` Passed to `MediaRouteProvider.RouteController#onUnselect(int)`, `Callback#onRouteUnselected(MediaRouter, RouteInfo, int)` and `Callback#onRouteSelected(MediaRouter, RouteInfo, int)` when the user pressed the disconnect button to disconnect and keep playing.
static Int	`UNSELECT_REASON_ROUTE_CHANGED` Passed to `MediaRouteProvider.RouteController#onUnselect(int)`, `Callback#onRouteUnselected(MediaRouter, RouteInfo, int)` and `Callback#onRouteSelected(MediaRouter, RouteInfo, int)` when the user selected a different route.
static Int	`UNSELECT_REASON_STOPPED` Passed to `MediaRouteProvider.RouteController#onUnselect(int)`, `Callback#onRouteUnselected(MediaRouter, RouteInfo, int)` and `Callback#onRouteSelected(MediaRouter, RouteInfo, int)` when the user pressed the stop casting button.
static Int	`UNSELECT_REASON_UNKNOWN` Passed to `MediaRouteProvider.RouteController#onUnselect(int)`, `Callback#onRouteUnselected(MediaRouter, RouteInfo, int)` and `Callback#onRouteSelected(MediaRouter, RouteInfo, int)` when the reason the route was unselected is unknown.

Public methods
Unit	`addCallback(selector: MediaRouteSelector!, callback: MediaRouter.Callback!)` Registers a callback to discover routes that match the selector and to receive events when they change.
Unit	`addCallback(@NonNull selector: MediaRouteSelector, @NonNull callback: MediaRouter.Callback, flags: Int)` Registers a callback to discover routes that match the selector and to receive events when they change.
Unit	`addProvider(@NonNull providerInstance: MediaRouteProvider)` Registers a media route provider within this application process.
Unit	`addRemoteControlClient(@NonNull remoteControlClient: Any)` Adds a remote control client to enable remote control of the volume of the selected route.
MediaRouter.RouteInfo!	`getBluetoothRoute()` Gets a bluetooth route for playing media content on the system.
MediaRouter.RouteInfo	`getDefaultRoute()` Gets the default route for playing media content on the system.
static MediaRouter!	`getInstance(@NonNull context: Context)` Gets an instance of the media router service associated with the context.
MediaSessionCompat.Token!	`getMediaSessionToken()`
MutableList<MediaRouter.ProviderInfo!>!	`getProviders()` Gets information about the `route providers` currently known to this media router.
MediaRouterParams?	`getRouterParams()` Gets `parameters` of the media router service associated with this media router.
MutableList<MediaRouter.RouteInfo!>!	`getRoutes()` Gets information about the `routes` currently known to this media router.
MediaRouter.RouteInfo	`getSelectedRoute()` Gets the currently selected route.
Boolean	`isRouteAvailable(@NonNull selector: MediaRouteSelector, flags: Int)` Returns true if there is a route that matches the specified selector.
Unit	`removeCallback(@NonNull callback: MediaRouter.Callback)` Removes the specified callback.
Unit