MediaRouter.RouteInfo

const val CONNECTION_STATE_CONNECTED = 2: Int

A connection state indicating the route is connected.

const val CONNECTION_STATE_CONNECTING = 1: Int

A connection state indicating the route is in the process of connecting and is not yet ready for use.

const val CONNECTION_STATE_DISCONNECTED = 0: Int

The default connection state indicating the route is disconnected.

const val DEVICE_TYPE_AUDIO_VIDEO_RECEIVER = 4: Int

A receiver device type indicating that the presentation of the media is happening on an Audio/Video receiver (AVR).

const val DEVICE_TYPE_BLE_HEADSET = 22: Int

A receiver device type indicating the presentation of the media is happening on a Bluetooth Low Energy (BLE) HEADSET.

const val DEVICE_TYPE_BLUETOOTH_A2DP = 3: Int

A receiver device type of the route indicating the presentation of the media is happening on a bluetooth device such as a bluetooth speaker.

const val DEVICE_TYPE_BUILTIN_SPEAKER = 12: Int

A receiver device type indicating the presentation of the media is happening on a speaker system (i.e. a mono speaker or stereo speakers) built into the device.

const val DEVICE_TYPE_CAR = 9: Int

A receiver device type indicating that the presentation of the media is happening on a car.

const val DEVICE_TYPE_COMPUTER = 7: Int

A receiver device type indicating that the presentation of the media is happening on a computer.

const val DEVICE_TYPE_DOCK = 19: Int

A receiver device type indicating the presentation of the media is happening on an audio device associated on a dock.

const val DEVICE_TYPE_GAME_CONSOLE = 8: Int

A receiver device type indicating that the presentation of the media is happening on a gaming console.

const val DEVICE_TYPE_GROUP = 1000: Int

A receiver device type indicating that the presentation of the media is happening on a group of devices.

const val DEVICE_TYPE_HDMI = 16: Int

A receiver device type indicating the presentation of the media is happening on an HDMI connection.

const val DEVICE_TYPE_HDMI_ARC = 23: Int

A receiver device type indicating the presentation of the media is happening on an Audio Return Channel of an HDMI connection

const val DEVICE_TYPE_HDMI_EARC = 24: Int

A receiver device type indicating the presentation of the media is happening on an Enhanced Audio Return Channel of an HDMI connection

const val DEVICE_TYPE_HEARING_AID = 21: Int

A receiver device type indicating the presentation of the media is happening on a hearing aid device.

const val DEVICE_TYPE_REMOTE_SPEAKER = 2: Int

A receiver device type of the route indicating the presentation of the media is happening on a remote speaker.

const val DEVICE_TYPE_SMARTPHONE = 11: Int

A receiver device type indicating that the presentation of the media is happening on a smartphone.

const val DEVICE_TYPE_SMARTWATCH = 10: Int

A receiver device type indicating that the presentation of the media is happening on a smartwatch.

const val DEVICE_TYPE_SPEAKER = 2: Int

A receiver device type of the route indicating the presentation of the media is happening on a speaker.

const val DEVICE_TYPE_TABLET = 5: Int

A receiver device type indicating that the presentation of the media is happening on a tablet.

const val DEVICE_TYPE_TABLET_DOCKED = 6: Int

A receiver device type indicating that the presentation of the media is happening on a docked tablet.

const val DEVICE_TYPE_TV = 1: Int

A receiver device type of the route indicating the presentation of the media is happening on a TV.

const val DEVICE_TYPE_USB_ACCESSORY = 18: Int

A receiver device type indicating the presentation of the media is happening on a USB audio device in accessory mode.

const val DEVICE_TYPE_USB_DEVICE = 17: Int

A receiver device type indicating the presentation of the media is happening on a USB audio device.

const val DEVICE_TYPE_USB_HEADSET = 20: Int

A receiver device type indicating the presentation of the media is happening on a USB audio headset.

const val DEVICE_TYPE_WIRED_HEADPHONES = 14: Int

A receiver device type indicating the presentation of the media is happening on a pair of wired headphones.

const val DEVICE_TYPE_WIRED_HEADSET = 13: Int

A receiver device type indicating the presentation of the media is happening on a headset, which is the combination of a headphones and a microphone.

const val PLAYBACK_TYPE_LOCAL = 0: Int

The default playback type, "local", indicating the presentation of the media is happening on the same device (e.g. a phone, a tablet) as where it is controlled from.

const val PLAYBACK_TYPE_REMOTE = 1: Int

A playback type indicating the presentation of the media is happening on a different device (i.e. the remote device) than where it is controlled from.

const val PLAYBACK_VOLUME_FIXED = 0: Int

Playback information indicating the playback volume is fixed, i.e. it cannot be controlled from this object. An example of fixed playback volume is a remote player, playing over HDMI where the user prefers to control the volume on the HDMI sink, rather than attenuate at the source.

const val PLAYBACK_VOLUME_VARIABLE = 1: Int

Playback information indicating the playback volume is variable and can be controlled from this object.

fun canDisconnect(): Boolean

Gets whether this route supports disconnecting without interrupting playback.

@MainThread
fun connect(): Unit

Connects this route without selecting it.

A route may be selected or connected. Route selection is performed using the select method. The media router library supports a single selected route which is typically the active playback device chosen by the user. This method enables connection to additional routes while maintaining the current route selection. If the specified route is already selected, this method has no effect.

The route controller dialog should display only the selected route, as this is the one users directly interact with. Connected routes are typically managed by the application in the background and are not generally relevant to the user.

After calling this method to connect a route, the application will receive the onRouteConnected callback when the connection is established. The connected RouteInfo can then be used to send control commands to the route. If the connection fails, the application receives the onRouteDisconnected callback with error details.

Must be called on the main thread.

@MainThread
fun disconnect(): Unit

Disconnects this route.

If it is a connected route, then it will disconnect this route. If it is a selected route, disconnecting this route will do nothing.

After calling this method to disconnect a route, the application receives the onRouteDisconnected callback.

Must be called on the main thread.

fun getConnectionState(): Int

Gets the connection state of the route.

fun getControlFilters(): (Mutable)List<IntentFilter!>

Gets a list of media control intent filters that describe the capabilities of this route and the media control actions that it supports.

fun getDescription(): String?

Gets the user-visible description of the route.

The route description describes the kind of destination represented by the route. It may be a user-supplied string, a model number or brand of device.

fun getDeviceType(): Int

Gets the type of the receiver device associated with this route.

fun getExtras(): Bundle?

Gets a collection of extra properties about this route that were supplied by its media route provider, or null if none.

fun getIconUri(): Uri?

Gets the URI of the icon representing this route.

This icon will be used in picker UIs if available.

fun getId(): String

Gets the unique id of the route.

The route unique id functions as a stable identifier by which the route is known. For example, an application can use this id as a token to remember the selected route across restarts or to communicate its identity to a service.

fun getMediaRouteDescriptor(): MediaRouteDescriptor?

Returns the MediaRouteDescriptor of this media route info or null if it is not updated by its provider yet.

fun getName(): String

Gets the user-visible name of the route.

The route name identifies the destination represented by the route. It may be a user-supplied name, an alias, or device serial number.

fun getPlaybackStream(): Int

Gets the audio stream over which the playback associated with this route is performed.

fun getPlaybackType(): Int

Gets the type of playback associated with this route.

@MainThread
fun getPresentationDisplay(): Display?

Gets the Display that should be used by the application to show a android.app.Presentation on an external display when this route is selected. Depending on the route, this may only be valid if the route is currently selected.

The preferred presentation display may change independently of the route being selected or unselected. For example, the presentation display of the default system route may change when an external HDMI display is connected or disconnected even though the route itself has not changed.

This method may return null if there is no external display associated with the route or if the display is not ready to show UI yet.

The application should listen for changes to the presentation display using the onRoutePresentationDisplayChanged callback and show or dismiss its android.app.Presentation accordingly when the display becomes available or is removed.

This method only makes sense for live video routes.

Must be called on the main thread.

fun getProvider(): MediaRouter.ProviderInfo

Gets information about the provider of this media route.

fun getSettingsIntent(): IntentSender?

Gets an intent sender for launching a settings activity for this route.

fun getVolume(): Int

Gets the current volume for this route. Depending on the route, this may only be valid if the route is currently selected.

fun getVolumeHandling(): Int

Gets information about how volume is handled on the route.

fun getVolumeMax(): Int

Gets the maximum volume at which the playback associated with this route is performed.

@MainThread
fun isBluetooth(): Boolean

Returns true if this route is a bluetooth route.

Must be called on the main thread.

fun isConnecting(): Boolean

Returns true if the route is in the process of connecting and is not yet ready for use.

@MainThread
fun isDefault(): Boolean

Returns true if this route is the default route.

Must be called on the main thread.

fun isDeviceSpeaker(): Boolean

Returns true if this route is the default route and the device speaker.

fun isEnabled(): Boolean

Returns true if this route is enabled and may be selected.

@MainThread
fun isSelected(): Boolean

Returns true if this route is currently selected.

Only one representative route can return true. For instance:

• If this route is a selected (non-group) route, it returns true.
• If this route is a selected group route, it returns true.
• If this route is a selected member route of a group, it returns false.

Must be called on the main thread.

fun isSystemRoute(): Boolean

Returns true if this route is a system route.

System routes are routes controlled by the system, like the device's built-in speakers, wired headsets, and bluetooth devices.

To use system routes, your application should write media sample data to a media framework API, typically via ExoPlayer.

@MainThread
fun matchesSelector(selector: MediaRouteSelector): Boolean

Returns true if the route supports at least one of the capabilities described by a media route selector.

Must be called on the main thread.

@MainThread
fun requestSetVolume(volume: Int): Unit

Requests a volume change for this route asynchronously.

This function may only be called on a selected route. It will have no effect if the route is currently unselected.

Must be called on the main thread.

@MainThread
fun requestUpdateVolume(delta: Int): Unit

Requests an incremental volume update for this route asynchronously.

This function may only be called on a selected route. It will have no effect if the route is currently unselected.

Must be called on the main thread.

@MainThread
fun select(): Unit

Selects this media route.

Must be called on the main thread.

@MainThread
fun sendControlRequest(
    intent: Intent,
    callback: MediaRouter.ControlRequestCallback?
): Unit

Sends a media control request to be performed asynchronously by the route's destination.

Media control requests are used to request the route to perform actions such as starting remote playback of a media item.

This function may only be called on a selected route. Control requests sent to unselected routes will fail.

Must be called on the main thread.

@MainThread
fun supportsControlAction(category: String, action: String): Boolean

Returns true if the route supports the specified media control category and action.

Media control actions describe specific requests that an application can ask a route to perform.

Must be called on the main thread.

@MainThread
fun supportsControlCategory(category: String): Boolean

Returns true if the route supports the specified media control category.

Media control categories describe the capabilities of this route such as whether it supports live audio streaming or remote playback.

Must be called on the main thread.

@MainThread
fun supportsControlRequest(intent: Intent): Boolean

Returns true if the route supports the specified media control request.

Media control requests are used to request the route to perform actions such as starting remote playback of a media item.

Must be called on the main thread.