Added in API level 30

MediaRouter2

class MediaRouter2
kotlin.Any
   ↳ android.media.MediaRouter2

This API is not generally intended for third party application developers. Use the AndroidX Media Router Library for consistent behavior across all devices.

MediaRouter2 allows applications to control the routing of media channels and streams from the current device to remote speakers and devices.

Summary

Nested classes
abstract

Callback for receiving RoutingController updates.

abstract

A listener interface to send optional app-specific hints when creating a RoutingController.

abstract

Callback for receiving events about media route discovery.

A class to control media routing session in media route provider.

abstract

Callback for receiving events on media transfer.

Public methods
MediaRouter2.RoutingController?

Gets a RoutingController whose ID is equal to the given ID.

MutableList<MediaRouter2.RoutingController!>

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

static MediaRouter2
getInstance(context: Context)

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

RouteListingPreference?

Returns the current RouteListingPreference of the target router.

MutableList<MediaRoute2Info!>

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

MediaRouter2.RoutingController

Gets a RoutingController which can control the routes provided by system.

Unit

Registers a ControllerCallback.

Unit

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

Unit

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

Unit

Registers a callback to get the result of transferTo(android.media.MediaRoute2Info).

Unit

Sets an OnGetControllerHintsListener to send hints when creating a RoutingController.

Unit

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

Boolean

Shows the system output switcher dialog.

Unit

Stops the current media routing.

Unit

Transfers the current media to the given route.

Unit

Unregisters a ControllerCallback.

Unit

Unregisters the given callback.

Unit

Unregisters the given callback to not receive RouteListingPreference change events.

Unit

Unregisters the given callback.

Public methods

getController

Added in API level 31
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.

Parameters
id String: This value cannot be null.

getControllers

Added in API level 30
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.

Return
MutableList<MediaRouter2.RoutingController!> This value cannot be null.

getInstance

Added in API level 30
static fun getInstance(context: Context): MediaRouter2

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

Parameters
context Context: This value cannot be null.
Return
MediaRouter2 This value cannot be null.

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.

Return
RouteListingPreference? This value may be null.

getRoutes

Added in API level 30
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.

Return
MutableList<MediaRoute2Info!> the list of routes that contains at least one of the route features in discovery preferences registered by the application This value cannot be null.

getSystemController

Added in API level 30
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.

Return
MediaRouter2.RoutingController This value cannot be null.

registerControllerCallback

Added in API level 30
fun registerControllerCallback(
    executor: Executor,
    callback: MediaRouter2.ControllerCallback
): Unit

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

Parameters
executor Executor: This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.
callback MediaRouter2.ControllerCallback: This value cannot be null.

registerRouteCallback

Added in API level 30
fun registerRouteCallback(
    executor: Executor,
    routeCallback: MediaRouter2.RouteCallback,
    preference: RouteDiscoveryPreference
): Unit

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

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

Parameters
executor Executor: This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.
routeCallback MediaRouter2.RouteCallback: This value cannot be null.
preference RouteDiscoveryPreference: This value cannot be null.

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.

Parameters
executor Executor: This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.
routeListingPreferenceCallback Consumer<RouteListingPreference!>: This value cannot be null.

registerTransferCallback

Added in API level 30
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.

Parameters
executor Executor: the executor to execute the callback on This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.
callback MediaRouter2.TransferCallback: the callback to register This value cannot be null.

setOnGetControllerHintsListener

Added in API level 30
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).

Parameters
listener MediaRouter2.OnGetControllerHintsListener?: A listener to send optional app-specific hints when creating a controller. null for unset.

setRouteListingPreference

Added in API level 34
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.
Parameters
routeListingPreference RouteListingPreference?: The RouteListingPreference for the system to use for route listing. When null, the system uses its default listing criteria.

showSystemOutputSwitcher

Added in API level 34
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.

Return
Boolean true if the output switcher dialog is being shown, or false if the call is ignored because the app is in the background.

stop

Added in API level 30
fun stop(): Unit

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

transferTo

Added in API level 30
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.

Parameters
route MediaRoute2Info: the route you want to transfer the current media to. Pass null to stop routing of the current media.

unregisterControllerCallback

Added in API level 30
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.

Parameters
callback MediaRouter2.ControllerCallback: This value cannot be null.

unregisterRouteCallback

Added in API level 30
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.

Parameters
routeCallback MediaRouter2.RouteCallback: the callback to unregister This value cannot be null.

unregisterRouteListingPreferenceUpdatedCallback

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

Unregisters the given callback to not receive RouteListingPreference change events.

Parameters
callback Consumer<RouteListingPreference!>: This value cannot be null.

unregisterTransferCallback

Added in API level 30
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.

Parameters
callback MediaRouter2.TransferCallback: the callback to unregister This value cannot be null.