added in version 22.1.0
belongs to Maven artifact com.android.support:mediarouter-v7:28.0.0-alpha1
Summary: Constants | Methods | Inherited Methods | [Expand All]

MediaRouter.RouteInfo

public static class MediaRouter.RouteInfo
extends Object

java.lang.Object
   ↳ android.support.v7.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

int CONNECTION_STATE_CONNECTED

A connection state indicating the route is connected.

int CONNECTION_STATE_CONNECTING

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

int CONNECTION_STATE_DISCONNECTED

The default connection state indicating the route is disconnected.

int DEVICE_TYPE_SPEAKER

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

int DEVICE_TYPE_TV

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

int PLAYBACK_TYPE_LOCAL

The default playback type, "local", indicating the presentation of the media is happening on the same device (e.g.

int PLAYBACK_TYPE_REMOTE

A playback type indicating the presentation of the media is happening on a different device (i.e.

int PLAYBACK_VOLUME_FIXED

Playback information indicating the playback volume is fixed, i.e.

int PLAYBACK_VOLUME_VARIABLE

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

Public methods

boolean canDisconnect()

Gets whether this route supports disconnecting without interrupting playback.

int getConnectionState()

Gets the connection state of the route.

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

String getDescription()

Gets the user-visible description of the route.

int getDeviceType()

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

Bundle getExtras()

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

Uri getIconUri()

Gets the URI of the icon representing this route.

String getId()

Gets the unique id of the route.

String getName()

Gets the user-visible name of the route.

int getPlaybackStream()

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

int getPlaybackType()

Gets the type of playback associated with this route.

Display getPresentationDisplay()

Gets the Display that should be used by the application to show a Presentation on an external display when this route is selected.

MediaRouter.ProviderInfo getProvider()

Gets information about the provider of this media route.

IntentSender getSettingsIntent()

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

int getVolume()

Gets the current volume for this route.

int getVolumeHandling()

Gets information about how volume is handled on the route.

int getVolumeMax()

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

boolean isBluetooth()

Returns true if this route is a bluetooth route.

boolean isConnecting()

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

boolean isDefault()

Returns true if this route is the default route.

boolean isDeviceSpeaker()

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

boolean isEnabled()

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

boolean isSelected()

Returns true if this route is currently selected.

boolean matchesSelector(MediaRouteSelector selector)

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

void requestSetVolume(int volume)

Requests a volume change for this route asynchronously.

void requestUpdateVolume(int delta)

Requests an incremental volume update for this route asynchronously.

void select()

Selects this media route.

void sendControlRequest(Intent intent, MediaRouter.ControlRequestCallback callback)

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

boolean supportsControlAction(String category, String action)

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

boolean supportsControlCategory(String category)

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

boolean supportsControlRequest(Intent intent)

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

String toString()

Inherited methods

From class java.lang.Object

Constants

CONNECTION_STATE_CONNECTED

added in version 24.1.0 
int CONNECTION_STATE_CONNECTED

A connection state indicating the route is connected.

Constant Value: 2 (0x00000002)

CONNECTION_STATE_CONNECTING

added in version 24.1.0 
int CONNECTION_STATE_CONNECTING

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

Constant Value: 1 (0x00000001)

CONNECTION_STATE_DISCONNECTED

added in version 24.1.0 
int CONNECTION_STATE_DISCONNECTED

The default connection state indicating the route is disconnected.

Constant Value: 0 (0x00000000)

DEVICE_TYPE_SPEAKER

added in version 24.1.0 
int DEVICE_TYPE_SPEAKER

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

See also:

Constant Value: 2 (0x00000002)

DEVICE_TYPE_TV

added in version 24.1.0 
int DEVICE_TYPE_TV

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

See also:

Constant Value: 1 (0x00000001)

PLAYBACK_TYPE_LOCAL

added in version 22.1.0 
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.

See also:

Constant Value: 0 (0x00000000)

PLAYBACK_TYPE_REMOTE

added in version 22.1.0 
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.

See also:

Constant Value: 1 (0x00000001)

PLAYBACK_VOLUME_FIXED

added in version 22.1.0 
int PLAYBACK_VOLUME_FIXED

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.

Constant Value: 0 (0x00000000)

PLAYBACK_VOLUME_VARIABLE

added in version 22.1.0 
int PLAYBACK_VOLUME_VARIABLE

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

Constant Value: 1 (0x00000001)

Public methods

canDisconnect

added in version 22.1.0
boolean canDisconnect ()

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 version 24.1.0
int getConnectionState ()

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 version 22.1.0
List<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.

Returns
List<IntentFilter> A list of intent filters that specifies the media control intents that this route supports.

getDescription

added in version 22.1.0
String getDescription ()

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 version 24.1.0
int getDeviceType ()

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

Returns
int The type of the receiver device associated with this route: DEVICE_TYPE_TV or DEVICE_TYPE_SPEAKER.

getExtras

added in version 22.1.0
Bundle getExtras ()

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

Returns
Bundle

getIconUri

added in version 24.1.0
Uri getIconUri ()

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 version 22.1.0
String getId ()

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 version 22.1.0
String getName ()

Gets the user-visible name of the route.

The route name