public
static
class
MediaRouter.RouteInfo
extends Object
| java.lang.Object | |
| ↳ | android.media.MediaRouter.RouteInfo |
 Known Direct Subclasses
|
Information about a media route.
Constants | |
|---|---|
int |
DEVICE_TYPE_BLUETOOTH
A receiver device type of the route indicating the presentation of the media is happening on a bluetooth device such as a bluetooth speaker. |
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 |
DEVICE_TYPE_UNKNOWN
The default receiver device type of the route indicating the type is unknown. |
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. |
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. |
int |
PLAYBACK_VOLUME_FIXED
Playback information indicating the playback volume is fixed, i.e. it cannot be controlled from this object. |
int |
PLAYBACK_VOLUME_VARIABLE
Playback information indicating the playback volume is variable and can be controlled from this object. |
Public methods | |
|---|---|
MediaRouter.RouteCategory
|
getCategory()
|
CharSequence
|
getDescription()
Gets the user-visible description of the route. |
int
|
getDeviceType()
Gets the type of the receiver device associated with this route. |
MediaRouter.RouteGroup
|
getGroup()
|
Drawable
|
getIconDrawable()
Get the icon representing this route. |
CharSequence
|
getName(Context context)
Return the properly localized/resource user-visible name of this route. |
CharSequence
|
getName()
Gets the user-visible name of the route. |
int
|
getPlaybackStream()
|
int
|
getPlaybackType()
|
Display
|
getPresentationDisplay()
Gets the |
CharSequence
|
getStatus()
|
int
|
getSupportedTypes()
|
Object
|
getTag()
|
int
|
getVolume()
Return the current volume for this route. |
int
|
getVolumeHandling()
|
int
|
getVolumeMax()
|
boolean
|
isConnecting()
Returns true if the route is in the process of connecting and is not yet ready for use. |
boolean
|
isEnabled()
Returns true if this route is enabled and may be selected. |
void
|
requestSetVolume(int volume)
Request a volume change for this route. |
void
|
requestUpdateVolume(int direction)
Request an incremental volume update for this route. |
void
|
setTag(Object tag)
Set an application-specific tag object for this route. |
String
|
toString()
Returns a string representation of the object. |
Inherited methods | |
|---|---|
From
class
java.lang.Object
| |
int DEVICE_TYPE_BLUETOOTH
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:
Constant Value: 3 (0x00000003)
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)
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)
int DEVICE_TYPE_UNKNOWN
The default receiver device type of the route indicating the type is unknown.
See also:
Constant Value: 0 (0x00000000)
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)
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)
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.
See also:
Constant Value: 0 (0x00000000)
int PLAYBACK_VOLUME_VARIABLE
Playback information indicating the playback volume is variable and can be controlled from this object.
See also:
Constant Value: 1 (0x00000001)
MediaRouter.RouteCategory getCategory ()
| Returns | |
|---|---|
MediaRouter.RouteCategory |
the category this route belongs to. |
CharSequence 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 | |
|---|---|
CharSequence |
The description of the route, or null if none. |
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_BLUETOOTH, DEVICE_TYPE_TV, DEVICE_TYPE_SPEAKER,
or DEVICE_TYPE_UNKNOWN.
|
MediaRouter.RouteGroup getGroup ()
| Returns | |
|---|---|
MediaRouter.RouteGroup |
The group that this route belongs to. |
Drawable getIconDrawable ()
Get the icon representing this route. This icon will be used in picker UIs if available.
| Returns | |
|---|---|
Drawable |
the icon representing this route or null if no icon is available |
CharSequence getName (Context context)
Return the properly localized/resource user-visible name of this route.
The route name identifies the destination represented by the route. It may be a user-supplied name, an alias, or device serial number.
| Parameters | |
|---|---|
context |
Context:
Context used to resolve the correct configuration to load |
| Returns | |
|---|---|
CharSequence |
The user-visible name of a media route. This is the string presented to users who may select this as the active route. |
CharSequence 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 | |
|---|---|
CharSequence |
The user-visible name of a media route. This is the string presented to users who may select this as the active route. |
int getPlaybackStream ()
| Returns | |
|---|---|
int |
the stream over which the playback associated with this route is performed |
See also:
int getPlaybackType ()
| Returns | |
|---|---|
int |
the type of playback associated with this route |
See also:
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.
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(MediaRouter, MediaRouter.RouteInfo) callback and
show or dismiss its Presentation accordingly when the display
becomes available or is removed.
This method only makes sense for live video routes.
| Returns | |
|---|---|
Display |
The preferred presentation display to use when this route is selected or null if none. |
See also:
CharSequence getStatus ()
| Returns | |
|---|---|
CharSequence |
The user-visible status for a media route. This may include a description of the currently playing media, if available. |
int getSupportedTypes ()
| Returns | |
|---|---|
int |
A media type flag set describing which types this route supports. |
Object getTag ()
| Returns | |
|---|---|
Object |
The tag object previously set by the application |
See also:
int getVolume ()
Return 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 |
See also:
int getVolumeHandling ()
| Returns | |
|---|---|
int |
how volume is handling on the route |
See also:
int getVolumeMax ()
| Returns | |
|---|---|
int |
the maximum volume at which the playback associated with this route is performed |
See also:
boolean isConnecting ()
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. |
boolean isEnabled ()
Returns true if this route is enabled and may be selected.
| Returns | |
|---|---|
boolean |
True if this route is enabled. |
void requestSetVolume (int volume)
Request a volume change for this route.
| Parameters | |
|---|---|
volume |
int:
value between 0 and getVolumeMax
|
void requestUpdateVolume (int direction)
Request an incremental volume update for this route.
| Parameters | |
|---|---|
direction |
int:
Delta to apply to the current volume
|
void setTag (Object tag)
Set an application-specific tag object for this route. The application may use this to store arbitrary data associated with the route for internal tracking.
Note that the lifespan of a route may be well past the lifespan of an Activity or other Context; take care that objects you store here will not keep more data in memory alive than you intend.
| Parameters | |
|---|---|
tag |
Object:
Arbitrary, app-specific data for this route to hold for later use
|
String toString ()
Returns a string representation of the object. In general, the
toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
| Returns | |
|---|---|
String |
a string representation of the object. |
Developers