MediaRouter2

cancelScanRequest

fun cancelScanRequest(token: MediaRouter2.ScanToken): Unit

Releases the active scan request linked to the provided ScanToken.

getController

fun getController(id: String): MediaRouter2.RoutingController?

Gets a RoutingController whose ID is equal to the given ID. Returns null if there is no matching controller.

getControllers

fun getControllers(): MutableList<MediaRouter2.RoutingController!>

Gets the list of currently active routing controllers on which media can be played.

Note: The list returned here will never be empty. The first element in the list is always the system controller.

getInstance

static fun getInstance(context: Context): MediaRouter2

Gets an instance of the media router associated with the context.

getInstance

static fun getInstance(
    context: Context, 
    clientPackageName: String, 
    executor: Executor, 
    onInstanceInvalidatedListener: Runnable
): MediaRouter2

Returns a proxy MediaRouter2 instance that allows you to control the routing of an app specified by clientPackageName. Returns null if the specified package name does not exist.

Proxy MediaRouter2 instances operate differently than regular MediaRouter2 instances:

• registerRouteCallback ignores any preference passed by a proxy router. Use android.media.RouteDiscoveryPreference#EMPTY when setting a route callback.

• Methods returning non-system controllers always return new instances with the latest data. Do not attempt to compare or store them. Instead, use getController(java.lang.String) or getControllers() to query the most up-to-date state.

• Calls to setOnGetControllerHintsListener are ignored.

Use this method when you only hold a revocable version of android.Manifest.permission#MEDIA_ROUTING_CONTROL (e.g. acquired via the AppOpsManager). Otherwise, use #getInstance(android.content.Context,java.lang.String).

onInstanceInvalidatedListener is called when the instance is invalidated because the calling app has lost Manifest.permission#MEDIA_ROUTING_CONTROL and does not hold Manifest.permission#MEDIA_CONTENT_CONTROL. Do not use the invalidated instance after receiving this callback, as the system will ignore all operations. Call getInstance(android.content.Context,java.lang.String,java.util.concurrent.Executor,java.lang.Runnable) again after reacquiring the relevant permissions.
Requires android.Manifest.permission#MEDIA_CONTENT_CONTROL or android.Manifest.permission#MEDIA_ROUTING_CONTROL

getRouteListingPreference

fun getRouteListingPreference(): RouteListingPreference?

Returns the current RouteListingPreference of the target router.

If this instance was created using getInstance(Context, String), then it returns the last RouteListingPreference set by the process this router was created for.

getRoutes

fun getRoutes(): MutableList<MediaRoute2Info!>

Gets the unmodifiable list of routes currently known to the media router.

Please note that the list can be changed before callbacks are invoked.

getSystemController

fun getSystemController(): MediaRouter2.RoutingController

Gets a RoutingController which can control the routes provided by system. e.g. Phone speaker, wired headset, Bluetooth, etc.

Note: The system controller can't be released. Calling RoutingController#release() will be ignored.

This method always returns the same instance.

registerControllerCallback

fun registerControllerCallback(
    executor: Executor, 
    callback: MediaRouter2.ControllerCallback
): Unit

Registers a ControllerCallback. If you register the same callback twice or more, it will be ignored.

registerRouteCallback

fun registerRouteCallback(
    executor: Executor, 
    routeCallback: MediaRouter2.RouteCallback, 
    preference: RouteDiscoveryPreference
): Unit

Registers a callback to discover routes and to receive events when they change.

Clients can register multiple callbacks, as long as the RouteCallback instances are different. Each callback can provide a unique preference and will only receive updates related to that set preference.

If the specified callback is already registered, its registration will be updated for the given executor and discovery preference.

Local routers must register a route callback to register in the system and start receiving updates. Otherwise, all operations will be no-ops.

Any discovery preference passed by a #getInstance(android.content.Context,java.lang.String) will be ignored and will receive route updates based on the preference set by its matching local router.

registerRouteListingPreferenceUpdatedCallback

fun registerRouteListingPreferenceUpdatedCallback(
    executor: Executor, 
    routeListingPreferenceCallback: Consumer<RouteListingPreference!>
): Unit

Registers the given callback to be invoked when the RouteListingPreference of the target router changes.

Calls using a previously registered callback will overwrite the previous executor.

registerTransferCallback

fun registerTransferCallback(
    executor: Executor, 
    callback: MediaRouter2.TransferCallback
): Unit

Registers a callback to get the result of transferTo(android.media.MediaRoute2Info). If you register the same callback twice or more, it will be ignored.

requestScan

fun requestScan(scanRequest: MediaRouter2.ScanRequest): MediaRouter2.ScanToken

Requests the system to actively scan for routes based on the router's route discovery preference.

You must call cancelScanRequest(android.media.MediaRouter2.ScanToken) promptly to preserve system resources like battery. Avoid scanning unless there is clear intention from the user to start routing their media.

scanRequest specifies relevant scanning options, like whether the system should scan with the screen off. Screen off scanning requires android.Manifest.permission#MEDIA_ROUTING_CONTROL or android.Manifest.permission#MEDIA_CONTENT_CONTROL.

Proxy routers use the registered RouteDiscoveryPreference of their target routers.

setOnGetControllerHintsListener

fun setOnGetControllerHintsListener(listener: MediaRouter2.OnGetControllerHintsListener?): Unit

Sets an OnGetControllerHintsListener to send hints when creating a RoutingController. To send the hints, listener should be set BEFORE calling transferTo(android.media.MediaRoute2Info).

setRouteListingPreference

fun setRouteListingPreference(routeListingPreference: RouteListingPreference?): Unit

Sets the RouteListingPreference of the app associated to this media router.

Use this method to inform the system UI of the routes that you would like to list for media routing, via the Output Switcher.

You should call this method before registering any route and immediately after receiving any updates in order to keep the system UI in a consistent state. You can also call this method at any other point to update the listing preference dynamically.

Any calls to this method from a privileged router will throw an UnsupportedOperationException.

Notes:

1. You should not include the ids of two or more routes with a match in their deduplication ids. If you do, the system will deduplicate them using its own criteria.
2. You can use this method to rank routes in the output switcher, placing the more important routes first. The system might override the proposed ranking.
3. You can use this method to avoid listing routes using dynamic criteria. For example, you can limit access to a specific type of device according to runtime criteria.

setRouteVolume

fun setRouteVolume(
    route: MediaRoute2Info, 
    volume: Int
): Unit

Sets the volume for a specific route.

The call may have no effect if the route is currently not selected.

This method is only supported by #getInstance(android.content.Context,java.lang.String). Use RoutingController#setVolume(int) instead for local MediaRouter2 instances.

showSystemOutputSwitcher

fun showSystemOutputSwitcher(): Boolean

Shows the system output switcher dialog.

Should only be called when the context of MediaRouter2 is in the foreground and visible on the screen.

The appearance and precise behaviour of the system output switcher dialog may vary across different devices, OS versions, and form factors, but the basic functionality stays the same.

See Output Switcher documentation for more details.

stop

fun stop(): Unit

Stops the current media routing. If the system controller controls the media routing, this method is a no-op.

transferTo

fun transferTo(route: MediaRoute2Info): Unit

Transfers the current media to the given route. If it's necessary a new RoutingController is created or it is handled within the current routing controller.

unregisterControllerCallback

fun unregisterControllerCallback(callback: MediaRouter2.ControllerCallback): Unit

Unregisters a ControllerCallback. The callback will no longer receive events. If the callback has not been added or been removed already, it is ignored.

unregisterRouteCallback

fun unregisterRouteCallback(routeCallback: MediaRouter2.RouteCallback): Unit

Unregisters the given callback. The callback will no longer receive events. If the callback has not been added or been removed already, it is ignored.

unregisterRouteListingPreferenceUpdatedCallback

fun unregisterRouteListingPreferenceUpdatedCallback(callback: Consumer<RouteListingPreference!>): Unit

Unregisters the given callback to not receive RouteListingPreference change events.

unregisterTransferCallback

fun unregisterTransferCallback(callback: MediaRouter2.TransferCallback): Unit

Unregisters the given callback. The callback will no longer receive events. If the callback has not been added or been removed already, it is ignored.