Android APIs
public final class

MediaRouteDescriptor

extends Object
java.lang.Object
   ↳ android.support.v7.media.MediaRouteDescriptor

Class Overview

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 MediaRouteDescriptor.Builder instance.

Summary

Nested Classes
class MediaRouteDescriptor.Builder Builder for media route descriptors
Public Methods
Bundle asBundle()
Converts this object to a bundle for serialization.
boolean canDisconnectAndKeepPlaying()
Gets whether the route can be disconnected without stopping playback.
static MediaRouteDescriptor fromBundle(Bundle bundle)
Creates an instance from a bundle.
int getConnectionState()
Gets the connection state of the route.
List<IntentFilter> getControlFilters()
Gets the route's media control intent filters.
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 bundle of extras for this route descriptor.
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 route's playback stream.
int getPlaybackType()
Gets the type of playback associated with this route.
int getPresentationDisplayId()
Gets the route's presentation display id, or -1 if none.
IntentSender getSettingsActivity()
Gets an IntentSender for starting a settings activity for this route.
int getVolume()
Gets the route's current volume, or 0 if unknown.
int getVolumeHandling()
Gets information about how volume is handled on the route.
int getVolumeMax()
Gets the route's maximum volume, or 0 if unknown.
boolean isConnecting()
This method is deprecated. Use getConnectionState() instead
boolean isEnabled()
Gets whether the route is enabled.
boolean isValid()
Returns true if the route descriptor has all of the required fields.
String toString()
Returns a string containing a concise, human-readable description of this object.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public Bundle asBundle ()

Converts this object to a bundle for serialization.

Returns
Bundle The contents of the object represented as a bundle.

public boolean canDisconnectAndKeepPlaying ()

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(int) with UNSELECT_REASON_DISCONNECTED.

Returns
boolean

public static MediaRouteDescriptor fromBundle (Bundle bundle)

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.

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

public List<IntentFilter> getControlFilters ()

Gets the route's media control intent filters.

Returns
List<IntentFilter>

public 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

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

public Bundle getExtras ()

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.

Returns
Bundle

public Uri getIconUri ()

Gets the URI of the icon representing this route.

This icon will be used in picker UIs if available.

Returns
Uri

public String getId ()

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.

Returns
String

public String getName ()

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

public int getPlaybackStream ()

Gets the route's playback stream.

Returns
int

public int getPlaybackType ()

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.

public int getPresentationDisplayId ()

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

Returns
int

public IntentSender getSettingsActivity ()

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.

public int getVolume ()

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

Returns
int

public int getVolumeHandling ()

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.

public int getVolumeMax ()

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

Returns
int

public boolean isConnecting ()

This method is deprecated.
Use getConnectionState() instead

Gets whether the route is connecting.

Returns
boolean

public boolean isEnabled ()

Gets whether the route is enabled.

Returns
boolean

public boolean isValid ()

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

Returns
boolean

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
String a printable representation of this object.