RouteInfo
open class RouteInfo
kotlin.Any | |
↳ | android.media.MediaRouter.RouteInfo |
Information about a media route.
Summary
Constants | |
---|---|
static Int |
A receiver device type of the route indicating the presentation of the media is happening on a bluetooth device such as a bluetooth speaker. |
static Int |
A receiver device type of the route indicating the presentation of the media is happening on a speaker. |
static Int |
A receiver device type of the route indicating the presentation of the media is happening on a TV. |
static Int |
The default receiver device type of the route indicating the type is unknown. |
static 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. |
static 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. |
static Int |
Playback information indicating the playback volume is fixed, i. |
static Int |
Playback information indicating the playback volume is variable and can be controlled from this object. |
Public methods | |
---|---|
open MediaRouter.RouteCategory! | |
open CharSequence! |
Gets the user-visible description of the route. |
open Int |
Gets the type of the receiver device associated with this route. |
open MediaRouter.RouteGroup! |
getGroup() |
open Drawable! |
Get the icon representing this route. |
open CharSequence! |
getName() Gets the user-visible name of the route. |
open CharSequence! |
Return the properly localized/resource user-visible name of this route. |
open Int | |
open Int | |
open Display! |
Gets the |
open CharSequence! | |
open Int | |
open Any! |
getTag() |
open Int |
Return the current volume for this route. |
open Int | |
open Int | |
open Boolean |
Returns true if the route is in the process of connecting and is not yet ready for use. |
open Boolean |
Returns true if this route is enabled and may be selected. |
open Unit |
requestSetVolume(volume: Int) Request a volume change for this route. |
open Unit |
requestUpdateVolume(direction: Int) Request an incremental volume update for this route. |
open Unit |
Set an application-specific tag object for this route. |
open String |
toString() |
Constants
DEVICE_TYPE_BLUETOOTH
static val DEVICE_TYPE_BLUETOOTH: Int
A receiver device type of the route indicating the presentation of the media is happening on a bluetooth device such as a bluetooth speaker.
Value: 3
See Also
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
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
DEVICE_TYPE_UNKNOWN
static val DEVICE_TYPE_UNKNOWN: Int
The default receiver device type of the route indicating the type is unknown.
Value: 0
See Also
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
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
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
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
Public methods
getCategory
open fun getCategory(): MediaRouter.RouteCategory!
Return | |
---|---|
MediaRouter.RouteCategory! |
the category this route belongs to. |
getDescription
open fun getDescription(): CharSequence!
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 | |
---|---|
CharSequence! |
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_BLUETOOTH , DEVICE_TYPE_TV , DEVICE_TYPE_SPEAKER , or DEVICE_TYPE_UNKNOWN . Value is android.media.MediaRouter.RouteInfo#DEVICE_TYPE_UNKNOWN , android.media.MediaRouter.RouteInfo#DEVICE_TYPE_TV , android.media.MediaRouter.RouteInfo#DEVICE_TYPE_SPEAKER , or android.media.MediaRouter.RouteInfo#DEVICE_TYPE_BLUETOOTH |
getGroup
open fun getGroup(): MediaRouter.RouteGroup!
Return | |
---|---|
MediaRouter.RouteGroup! |
The group that this route belongs to. |
getIconDrawable
open fun getIconDrawable(): Drawable!
Get the icon representing this route. This icon will be used in picker UIs if available.
Return | |
---|---|
Drawable! |
the icon representing this route or null if no icon is available |
getName
open fun getName(): CharSequence!
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.
Return | |
---|---|
CharSequence! |
The user-visible name of a media route. This is the string presented to users who may select this as the active route. |
getName
open fun getName(context: Context!): CharSequence!
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 |
Return | |
---|---|
CharSequence! |
The user-visible name of a media route. This is the string presented to users who may select this as the active route. |
getPlaybackStream
open fun getPlaybackStream(): Int
Return | |
---|---|
Int |
the stream over which the playback associated with this route is performed |
getPlaybackType
open fun getPlaybackType(): Int
Return | |
---|---|
Int |
the type of playback associated with this route Value is android.media.MediaRouter.RouteInfo#PLAYBACK_TYPE_LOCAL , or android.media.MediaRouter.RouteInfo#PLAYBACK_TYPE_REMOTE |
getPresentationDisplay
open fun getPresentationDisplay(): Display!
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. 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 Callback#onRoutePresentationDisplayChanged
callback and show or dismiss its android.app.Presentation
accordingly when the display becomes available or is removed.
This method only makes sense for live video
routes.
Return | |
---|---|
Display! |
The preferred presentation display to use when this route is selected or null if none. |
getStatus
open fun getStatus(): CharSequence!
Return | |
---|---|
CharSequence! |
The user-visible status for a media route. This may include a description of the currently playing media, if available. |
getSupportedTypes
open fun getSupportedTypes(): Int
Return | |
---|---|
Int |
A media type flag set describing which types this route supports. |
getTag
open fun getTag(): Any!
Return | |
---|---|
Any! |
The tag object previously set by the application |
See Also
getVolume
open fun getVolume(): Int
Return the current volume for this route. Depending on the route, this may only be valid if the route is currently selected.
Return | |
---|---|
Int |
the volume at which the playback associated with this route is performed |
getVolumeHandling
open fun getVolumeHandling(): Int
Return | |
---|---|
Int |
how volume is handling on the route Value is android.media.MediaRouter.RouteInfo#PLAYBACK_VOLUME_FIXED , or android.media.MediaRouter.RouteInfo#PLAYBACK_VOLUME_VARIABLE |
getVolumeMax
open fun getVolumeMax(): Int
Return | |
---|---|
Int |
the maximum volume at which the playback associated with this route is performed |
isConnecting
open fun isConnecting(): Boolean
Returns true if the route is in the process of connecting and is not yet ready for use.
Return | |
---|---|
Boolean |
True if this route is in the process of connecting. |
isEnabled
open fun isEnabled(): Boolean
Returns true if this route is enabled and may be selected.
Return | |
---|---|
Boolean |
True if this route is enabled. |
requestSetVolume
open fun requestSetVolume(volume: Int): Unit
Request a volume change for this route.
Parameters | |
---|---|
volume |
Int: value between 0 and getVolumeMax |
requestUpdateVolume
open fun requestUpdateVolume(direction: Int): Unit
Request an incremental volume update for this route.
Parameters | |
---|---|
direction |
Int: Delta to apply to the current volume |
setTag
open fun setTag(tag: Any!): Unit
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 |
Any!: Arbitrary, app-specific data for this route to hold for later use |
toString
open fun toString(): String
Return | |
---|---|
String |
a string representation of the object. |