RouteInfo

Kotlin |Java

class RouteInfo

kotlin.Any
↳	androidx.mediarouter.media.MediaRouter.RouteInfo

Provides information about a media route.

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

Summary

Constants
static Int	CONNECTION_STATE_CONNECTED A connection state indicating the route is connected.
static Int	CONNECTION_STATE_CONNECTING A connection state indicating the route is in the process of connecting and is not yet ready for use.
static Int	CONNECTION_STATE_DISCONNECTED The default connection state indicating the route is disconnected.
static Int	DEVICE_TYPE_SPEAKER A receiver device type of the route indicating the presentation of the media is happening on a speaker.
static Int	DEVICE_TYPE_TV A receiver device type of the route indicating the presentation of the media is happening on a TV.
static Int	PLAYBACK_TYPE_LOCAL 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.
static Int	PLAYBACK_TYPE_REMOTE 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.
static Int	PLAYBACK_VOLUME_FIXED Playback information indicating the playback volume is fixed, i.
static Int	PLAYBACK_VOLUME_VARIABLE Playback information indicating the playback volume is variable and can be controlled from this object.

Public methods
open Boolean	canDisconnect() Gets whether this route supports disconnecting without interrupting playback.
open Int	getConnectionState() Gets the connection state of the route.
open MutableList<IntentFilter!>!	getControlFilters() Gets a list of media control intent filters that describe the capabilities of this route and the media control actions that it supports.
open String?	getDescription() Gets the user-visible description of the route.
open Int	getDeviceType() Gets the type of the receiver device associated with this route.
open Bundle?	getExtras() Gets a collection of extra properties about this route that were supplied by its media route provider, or null if none.
open Uri!	getIconUri() Gets the URI of the icon representing this route.
open String	getId() Gets the unique id of the route.
open String!	getName() Gets the user-visible name of the route.
open Int	getPlaybackStream() Gets the audio stream over which the playback associated with this route is performed.
open Int	getPlaybackType() Gets the type of playback associated with this route.
open Display?	getPresentationDisplay() 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.
open MediaRouter.ProviderInfo!	getProvider() Gets information about the provider of this media route.
open IntentSender?	getSettingsIntent() Gets an intent sender for launching a settings activity for this route.
open Int	getVolume() Gets the current volume for this route.
open Int	getVolumeHandling() Gets information about how volume is handled on the route.
open Int	getVolumeMax() Gets the maximum volume at which the playback associated with this route is performed.
open Boolean	isBluetooth() Returns true if this route is a bluetooth route.
open Boolean	isConnecting() Returns true if the route is in the process of connecting and is not yet ready for use.
open Boolean	isDefault() Returns true if this route is the default route.
open Boolean	isDeviceSpeaker() Returns true if this route is the default route and the device speaker.
open Boolean	isEnabled() Returns true if this route is enabled and may be selected.
open Boolean	isSelected() Returns true if this route is currently selected.
open Boolean	matchesSelector(@NonNull selector: MediaRouteSelector) Returns true if the route supports at least one of the capabilities described by a media route selector.
open Unit	requestSetVolume(volume: Int) Requests a volume change for this route asynchronously.
open Unit	requestUpdateVolume(delta: Int) Requests an incremental volume update for this route asynchronously.
open Unit	select() Selects this media route.
open Unit	sendControlRequest(@NonNull intent: Intent, @Nullable callback: MediaRouter.ControlRequestCallback?) Sends a media control request to be performed asynchronously by the route's destination.
open Boolean	supportsControlAction(@NonNull category: String, @NonNull action: String) Returns true if the route supports the specified media control category and action.
open Boolean	supportsControlCategory(@NonNull category: String) Returns true if the route supports the specified media control category.
open Boolean	supportsControlRequest(@NonNull intent: Intent) Returns true if the route supports the specified media control request.
open String	toString()

Constants

CONNECTION_STATE_CONNECTED

static val CONNECTION_STATE_CONNECTED: Int

A connection state indicating the route is connected.

Value: 2

See Also

• #getConnectionState

CONNECTION_STATE_CONNECTING

static val CONNECTION_STATE_CONNECTING: Int

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

Value: 1

See Also

• #getConnectionState

CONNECTION_STATE_DISCONNECTED

static val CONNECTION_STATE_DISCONNECTED: Int

The default connection state indicating the route is disconnected.

Value: 0

See Also

• #getConnectionState

DEVICE_TYPE_SPEAKER

static val DEVICE_TYPE_SPEAKER: Int

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

Value: 2

See Also

• #getDeviceType

DEVICE_TYPE_TV

static val DEVICE_TYPE_TV: Int

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

Value: 1

See Also

• #getDeviceType

PLAYBACK_TYPE_LOCAL

static val PLAYBACK_TYPE_LOCAL: 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.

Value: 0

See Also

• #getPlaybackType

PLAYBACK_TYPE_REMOTE

static val PLAYBACK_TYPE_REMOTE: 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.

Value: 1

See Also

• #getPlaybackType

PLAYBACK_VOLUME_FIXED

static val PLAYBACK_VOLUME_FIXED: 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.

Value: 0

See Also

• #getVolumeHandling

PLAYBACK_VOLUME_VARIABLE

static val PLAYBACK_VOLUME_VARIABLE: Int

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

Value: 1

See Also

• #getVolumeHandling

Public methods

canDisconnect

open fun canDisconnect(): Boolean

Gets whether this route supports disconnecting without interrupting playback.

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

getConnectionState

open fun getConnectionState(): Int

Gets the connection state of the route.

Return
Int	The connection state of this route: CONNECTION_STATE_DISCONNECTED, CONNECTION_STATE_CONNECTING, or CONNECTION_STATE_CONNECTED.

getControlFilters

open fun getControlFilters(): MutableList<IntentFilter!>!

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

Return
MutableList<IntentFilter!>!	A list of intent filters that specifies the media control intents that this route supports.

See Also

• MediaControlIntent
• #supportsControlCategory
• #supportsControlRequest

getDescription

@Nullable open 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.

Return
String?	The description of the route, or null if none.

getDeviceType

open fun getDeviceType(): Int

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

Return
Int	The type of the receiver device associated with this route: DEVICE_TYPE_TV or DE