MediaRouter.RouteInfo

class MediaRouter.RouteInfo


Provides information about a media route.

Each media route has a list of media controlintent filters that describe the capabilities of the route and the manner in which it is used and controlled.

Summary

Constants

const Int

A connection state indicating the route is connected.

const Int

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

const Int

The default connection state indicating the route is disconnected.

const Int

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

const Int

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

const 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 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 Int

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

const Int

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

const Int

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

const Int

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

const Int

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

const Int

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

const Int

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

const Int

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

const Int

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

const Int

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

const Int

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

const Int

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

const Int

This property is deprecated.

use DEVICE_TYPE_BUILTIN_SPEAKER and DEVICE_TYPE_REMOTE_SPEAKER instead.

const Int

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

const Int

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

const Int

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

const Int

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

const Int

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

const Int

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

const Int

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

const 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 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 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 Int

Playback information indicating the playback volume is fixed, i.e. it cannot be controlled from this object.

const Int

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

Public functions

Boolean

Gets whether this route supports disconnecting without interrupting playback.

Int

Gets the connection state of the route.

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

String?

Gets the user-visible description of the route.

Int

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

Bundle?

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

Uri?

Gets the URI of the icon representing this route.

String

Gets the unique id of the route.

String

Gets the user-visible name of the route.

Int

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

Int

Gets the type of playback associated with this route.

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.

MediaRouter.ProviderInfo

Gets information about the provider of this media route.

IntentSender?

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

Int

Gets the current volume for this route.

Int

Gets information about how volume is handled on the route.

Int

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

Boolean

Returns true if this route is a bluetooth route.

Boolean

This function is deprecated.

use getConnectionState instead.

Boolean

Returns true if this route is the default route.

Boolean

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

Boolean

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

Boolean

Returns true if this route is currently selected.

Boolean

Returns true if this route is a system route.

Boolean

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

Unit

Requests a volume change for this route asynchronously.

Unit

Requests an incremental volume update for this route asynchronously.

Unit

Selects this media route.

Unit

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

Boolean

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

Boolean

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

Boolean

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

String

Constants

CONNECTION_STATE_CONNECTED

Added in 1.1.0
const val CONNECTION_STATE_CONNECTED = 2: Int

A connection state indicating the route is connected.

CONNECTION_STATE_CONNECTING

Added in 1.1.0
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.

CONNECTION_STATE_DISCONNECTED

Added in 1.1.0
const val CONNECTION_STATE_DISCONNECTED = 0: Int

The default connection state indicating the route is disconnected.

DEVICE_TYPE_AUDIO_VIDEO_RECEIVER

Added in 1.6.0
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).

See also
getDeviceType

DEVICE_TYPE_BLE_HEADSET

Added in 1.7.0-rc01
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.

See also
getDeviceType

DEVICE_TYPE_BLUETOOTH_A2DP

Added in 1.7.0-rc01
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.

See also
getDeviceType

DEVICE_TYPE_BUILTIN_SPEAKER

Added in 1.7.0-rc01
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.

See also
getDeviceType

DEVICE_TYPE_CAR

Added in 1.6.0
const val DEVICE_TYPE_CAR = 9: Int

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

See also
getDeviceType

DEVICE_TYPE_COMPUTER

Added in 1.6.0
const val DEVICE_TYPE_COMPUTER = 7: Int

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

See also
getDeviceType

DEVICE_TYPE_DOCK

Added in 1.7.0-rc01
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.

See also
getDeviceType

DEVICE_TYPE_GAME_CONSOLE

Added in 1.6.0
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.

See also
getDeviceType

DEVICE_TYPE_GROUP

Added in 1.6.0
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.

See also
getDeviceType

DEVICE_TYPE_HDMI

Added in 1.7.0-rc01
const val DEVICE_TYPE_HDMI = 16: Int

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

See also
getDeviceType

DEVICE_TYPE_HDMI_ARC

Added in 1.7.0-rc01
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

See also
getDeviceType

DEVICE_TYPE_HDMI_EARC

Added in 1.7.0-rc01
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

See also
getDeviceType

DEVICE_TYPE_HEARING_AID

Added in 1.7.0-rc01
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.

See also
getDeviceType

DEVICE_TYPE_REMOTE_SPEAKER

Added in 1.7.0-rc01
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.

See also
getDeviceType

DEVICE_TYPE_SMARTPHONE

Added in 1.7.0-rc01
const val DEVICE_TYPE_SMARTPHONE = 11: Int

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

See also
getDeviceType

DEVICE_TYPE_SMARTWATCH

Added in 1.6.0
const val DEVICE_TYPE_SMARTWATCH = 10: Int

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

See also
getDeviceType

DEVICE_TYPE_SPEAKER

Added in 1.1.0
Deprecated in 1.7.0-rc01
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.

See also
getDeviceType

DEVICE_TYPE_TABLET

Added in 1.6.0
const val DEVICE_TYPE_TABLET = 5: Int

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

See also
getDeviceType

DEVICE_TYPE_TABLET_DOCKED

Added in 1.6.0
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.

See also
getDeviceType

DEVICE_TYPE_TV

Added in 1.1.0
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.

See also
getDeviceType

DEVICE_TYPE_USB_ACCESSORY

Added in 1.7.0-rc01
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.

See also
getDeviceType

DEVICE_TYPE_USB_DEVICE

Added in 1.7.0-rc01
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.

See also
getDeviceType

DEVICE_TYPE_USB_HEADSET

Added in 1.7.0-rc01
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.

See also
getDeviceType

DEVICE_TYPE_WIRED_HEADPHONES

Added in 1.7.0-rc01
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.

See also
getDeviceType

DEVICE_TYPE_WIRED_HEADSET

Added in 1.7.0-rc01
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.

See also
getDeviceType

PLAYBACK_TYPE_LOCAL

Added in 1.1.0
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.

See also
getPlaybackType

PLAYBACK_TYPE_REMOTE

Added in 1.1.0
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.

See also
getPlaybackType

PLAYBACK_VOLUME_FIXED

Added in 1.1.0
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.

PLAYBACK_VOLUME_VARIABLE

Added in 1.1.0
const val PLAYBACK_VOLUME_VARIABLE = 1: Int

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

Public functions

canDisconnect

Added in 1.1.0
fun canDisconnect(): Boolean

Gets whether this route supports disconnecting without interrupting playback.

Returns
Boolean

True if this route can disconnect without stopping playback, false otherwise.

getConnectionState

Added in 1.1.0
@MediaRouter.RouteInfo.ConnectionState
fun getConnectionState(): Int

Gets the connection state of the route.

getControlFilters

Added in 1.1.0
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.

Returns
(Mutable)List<IntentFilter!>

A list of intent filters that specifies the media control intents that this route supports.

getDescription

Added in 1.1.0
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.

Returns
String?

The description of the route, or null if none.

getDeviceType

Added in 1.1.0
fun getDeviceType(): Int

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

Returns
Int

The type of the receiver device associated with this route.

getExtras

Added in 1.1.0
fun getExtras(): Bundle?

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

getIconUri

Added in 1.1.0
fun getIconUri(): Uri?

Gets the URI of the icon representing this route.

This icon will be used in picker UIs if available.

Returns
Uri?

The URI of the icon representing this route, or null if none.

getId

Added in 1.1.0
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.

Returns
String

The unique id of the route, never null.

getName

Added in 1.1.0
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.

Returns
String

The user-visible name of a media route. This is the string presented to users who may select this as the active route.

getPlaybackStream

Added in 1.1.0
fun getPlaybackStream(): Int

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

Returns
Int

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

getPlaybackType

Added in 1.1.0
@MediaRouter.RouteInfo.PlaybackType
fun getPlaybackType(): Int

Gets the type of playback associated with this route.

Returns
Int

The type of playback associated with this route: PLAYBACK_TYPE_LOCAL or PLAYBACK_TYPE_REMOTE.

getPresentationDisplay

Added in 1.1.0
@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.

Returns
Display?

The preferred presentation display to use when this route is selected or null if none.

getProvider

Added in 1.1.0
fun getProvider(): MediaRouter.ProviderInfo

Gets information about the provider of this media route.

getSettingsIntent

Added in 1.1.0
fun getSettingsIntent(): IntentSender?

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

getVolume

Added in 1.1.0
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.

Returns
Int

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

getVolumeHandling

Added in 1.1.0
@MediaRouter.RouteInfo.PlaybackVolume
fun getVolumeHandling(): Int

Gets information about how volume is handled on the route.

Returns
Int

How volume is handled on the route: PLAYBACK_VOLUME_FIXED or PLAYBACK_VOLUME_VARIABLE.

getVolumeMax

Added in 1.1.0
fun getVolumeMax(): Int

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

Returns
Int

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

isBluetooth

Added in 1.1.0
@MainThread
fun isBluetooth(): Boolean

Returns true if this route is a bluetooth route.

Must be called on the main thread.

Returns
Boolean

True if this route is a bluetooth route.

isConnecting

Added in 1.1.0
Deprecated in 1.1.0
fun isConnecting(): Boolean

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

Returns
Boolean

True if this route is in the process of connecting.

isDefault

Added in 1.1.0
@MainThread
fun isDefault(): Boolean

Returns true if this route is the default route.

Must be called on the main thread.

Returns
Boolean

True if this route is the default route.

See also
getDefaultRoute

isDeviceSpeaker

Added in 1.1.0
fun isDeviceSpeaker(): Boolean

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

Returns
Boolean

True if this route is the default route and the device speaker.

isEnabled

Added in 1.1.0
fun isEnabled(): Boolean

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

Returns
Boolean

True if this route is enabled.

isSelected

Added in 1.1.0
@MainThread
fun isSelected(): Boolean

Returns true if this route is currently selected.

Must be called on the main thread.

Returns
Boolean

True if this route is currently selected.

See also
getSelectedRoute

isSystemRoute

Added in 1.7.0-rc01
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.

matchesSelector

Added in 1.1.0
@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.

Parameters
selector: MediaRouteSelector

The selector that specifies the capabilities to check.

Returns
Boolean

True if the route supports at least one of the capabilities described in the media route selector.

requestSetVolume

Added in 1.1.0
@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.

Parameters
volume: Int

The new volume value between 0 and getVolumeMax.

requestUpdateVolume

Added in 1.1.0
@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.

Parameters
delta: Int

The delta to add to the current volume.

select

Added in 1.1.0
@MainThread
fun select(): Unit

Selects this media route.

Must be called on the main thread.

sendControlRequest

Added in 1.1.0
@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.

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.

supportsControlAction

Added in 1.1.0
@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.

Parameters
category: String

A media control category such as CATEGORY_LIVE_AUDIO, CATEGORY_LIVE_VIDEO, CATEGORY_REMOTE_PLAYBACK, or a provider-defined media control category.

action: String

A media control action such as ACTION_PLAY.

Returns
Boolean

True if the route supports the specified intent action.

supportsControlCategory

Added in 1.1.0
@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.

Parameters
category: String

A media control category such as CATEGORY_LIVE_AUDIO, CATEGORY_LIVE_VIDEO, CATEGORY_REMOTE_PLAYBACK, or a provider-defined media control category.

Returns
Boolean

True if the route supports the specified intent category.

supportsControlRequest

Added in 1.1.0
@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.

Parameters
intent: Intent

A media control intent.

Returns
Boolean

True if the route can handle the specified intent.

toString

fun toString(): String