MediaRouteDescriptor

class MediaRouteDescriptor

Describes the properties of a route.

Each route is uniquely identified by an opaque id string. This token may take any form as long as it is unique within the media route provider.

This object is immutable once created using a Builder instance.

Summary

Nested types

Builder for media route descriptors.

Public functions
Bundle

Converts this object to a bundle for serialization.
Boolean

Gets whether the route can be disconnected without stopping playback.
java-static MediaRouteDescriptor?
fromBundle(bundle: Bundle?)

Creates an instance from a bundle.
(Mutable)Set<String!>

Gets the set of allowed packages which are able to see the route or an empty set if only the route provider's package is allowed to see this route.
Int

Gets the connection state of the route.
(Mutable)List<IntentFilter!>

Gets the route's media control intent filters.
(Mutable)Set<String!>

Gets the route's deduplication ids.
String?

Gets the user-visible description of the route.
Int

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

Gets a bundle of extras for this route descriptor.
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 route's playback stream.
Int

Gets the type of playback associated with this route.
Int

Gets the route's presentation display id, or -1 if none.
IntentSender?

Gets an IntentSender for starting a settings activity for this route.
Int

Gets the route's current volume, or 0 if unknown.
Int

Gets information about how volume is handled on the route.
Int

Gets the route's maximum volume, or 0 if unknown.
Boolean

This function is deprecated.

Use getConnectionState instead
Boolean

Returns if this route is a dynamic group route.
Boolean

Gets whether the route is enabled.
Boolean

Returns true if this route is a system route.
Boolean

Returns true if the route descriptor has all of the required fields.
Boolean

Gets whether the route visibility is public or not.
String

Public functions

asBundle

Added in 1.1.0
fun asBundle(): Bundle

Converts this object to a bundle for serialization.

Returns
Bundle

The contents of the object represented as a bundle.

canDisconnectAndKeepPlaying

Added in 1.1.0
fun canDisconnectAndKeepPlaying(): Boolean

Gets whether the route can be disconnected without stopping playback.

The route can normally be disconnected without stopping playback when the destination device on the route is connected to two or more source devices. The route provider should update the route immediately when the number of connected devices changes.

To specify that the route should disconnect without stopping use unselect with UNSELECT_REASON_DISCONNECTED.

fromBundle

Added in 1.1.0
java-static fun fromBundle(bundle: Bundle?): MediaRouteDescriptor?

Creates an instance from a bundle.

Parameters
bundle: Bundle?

The bundle, or null if none.
Returns
MediaRouteDescriptor?

The new instance, or null if the bundle was null.

getAllowedPackages

Added in 1.6.0
fun getAllowedPackages(): (Mutable)Set<String!>

Gets the set of allowed packages which are able to see the route or an empty set if only the route provider's package is allowed to see this route. This applies only when isVisibilityPublic returns false.

getConnectionState

Added in 1.1.0
fun getConnectionState(): Int

Gets the connection state of the route.

Returns
Int

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

getControlFilters

Added in 1.1.0
fun getControlFilters(): (Mutable)List<IntentFilter!>

Gets the route's media control intent filters.

getDeduplicationIds

Added in 1.6.0
fun getDeduplicationIds(): (Mutable)Set<String!>

Gets the route's deduplication ids.

Two routes are considered to come from the same receiver device if any of their respective deduplication ids match.

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.

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 bundle of extras for this route descriptor. The extras will be ignored by the media router but they may be used by applications.

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.

getId

Added in 1.1.0
fun getId(): String

Gets the unique id of the route.

The route id associated with a route descriptor functions as a stable identifier for the route and must be unique among all routes offered by the provider.

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.

getPlaybackStream

Added in 1.1.0
fun getPlaybackStream(): Int

Gets the route's playback stream.

getPlaybackType

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

getPresentationDisplayId

Added in 1.1.0
fun getPresentationDisplayId(): Int

Gets the route's presentation display id, or -1 if none.

getSettingsActivity

Added in 1.1.0
fun getSettingsActivity(): IntentSender?

Gets an IntentSender for starting a settings activity for this route. The activity may have specific route settings or general settings for the connected device or route provider.

Returns
IntentSender?

An IntentSender to start a settings activity.

getVolume

Added in 1.1.0
fun getVolume(): Int

Gets the route's current volume, or 0 if unknown.

getVolumeHandling

Added in 1.1.0
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 route's maximum volume, or 0 if unknown.

isConnecting

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

Gets whether the route is connecting.

isDynamicGroupRoute

Added in 1.1.0
fun isDynamicGroupRoute(): Boolean

Returns if this route is a dynamic group route.

MediaRouteProvider creates a dynamic group route when onCreateDynamicGroupRouteController is called. It happens when a single route or a single static group is selected.

If a single device or a static group is selected, the associated dynamic group route should not be seen by any client app because there is already one for the device. After user added more devices into the session, it should be seen by the client app. The provider can treat this by not setting the media intent for the dynamic group route if it contains only one member.

Returns
Boolean

true if this route is a dynamic group route.

isEnabled

Added in 1.1.0
fun isEnabled(): Boolean

Gets whether the route is enabled.

isSystemRoute

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

isValid

Added in 1.1.0
fun isValid(): Boolean

Returns true if the route descriptor has all of the required fields.

isVisibilityPublic

Added in 1.6.0
fun isVisibilityPublic(): Boolean

Gets whether the route visibility is public or not.

toString

fun toString(): String