MediaRouteDescriptor
public
final
class
MediaRouteDescriptor
extends Object
java.lang.Object | |
↳ | androidx.mediarouter.media.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 MediaRouteDescriptor.Builder
instance.
Summary
Nested classes | |
---|---|
class |
MediaRouteDescriptor.Builder
Builder for |
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 |
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 |
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 |
boolean
|
isDynamicGroupRoute()
Returns if this route is a dynamic group route. |
boolean
|
isEnabled()
Gets whether the route is enabled. |
boolean
|
isValid()
Returns true if the route descriptor has all of the required fields. |
String
|
toString()
|
Inherited methods | |
---|---|
Public methods
asBundle
public Bundle asBundle ()
Converts this object to a bundle for serialization.
Returns | |
---|---|
Bundle |
The contents of the object represented as a bundle. |
canDisconnectAndKeepPlaying
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
MediaRouter.unselect(int)
with
MediaRouter.UNSELECT_REASON_DISCONNECTED
.
Returns | |
---|---|
boolean |
fromBundle
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. |
getConnectionState
public int getConnectionState ()
Gets the connection state of the route.
Returns | |
---|---|
int |
The connection state of this route:
MediaRouter.RouteInfo.CONNECTION_STATE_DISCONNECTED ,
MediaRouter.RouteInfo.CONNECTION_STATE_CONNECTING , or
MediaRouter.RouteInfo.CONNECTION_STATE_CONNECTED .
|
getControlFilters
public List<IntentFilter> getControlFilters ()
Gets the route's media control intent
filters.
Returns | |
---|---|
List<IntentFilter> |
getDescription
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 |
getDeviceType
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:
MediaRouter.RouteInfo.DEVICE_TYPE_TV or
MediaRouter.RouteInfo.DEVICE_TYPE_SPEAKER .
|
getExtras
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 |
getIconUri
public Uri getIconUri ()
Gets the URI of the icon representing this route.
This icon will be used in picker UIs if available.
Returns | |
---|---|
Uri |
getId
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 |
getName
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 |
getPlaybackStream
public int getPlaybackStream ()
Gets the route's playback stream.
Returns | |
---|---|
int |
getPlaybackType
public int getPlaybackType ()
Gets the type of playback associated with this route.
Returns | |
---|---|
int |
The type of playback associated with this route:
MediaRouter.RouteInfo.PLAYBACK_TYPE_LOCAL or
MediaRouter.RouteInfo.PLAYBACK_TYPE_REMOTE .
|
getPresentationDisplayId
public int getPresentationDisplayId ()
Gets the route's presentation display id, or -1 if none.
Returns | |
---|---|
int |
getSettingsActivity
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.
|
getVolume
public int getVolume ()
Gets the route's current volume, or 0 if unknown.
Returns | |
---|---|
int |
getVolumeHandling
public int getVolumeHandling ()
Gets information about how volume is handled on the route.
Returns | |
---|---|
int |
How volume is handled on the route:
MediaRouter.RouteInfo.PLAYBACK_VOLUME_FIXED or
MediaRouter.RouteInfo.PLAYBACK_VOLUME_VARIABLE .
|
getVolumeMax
public int getVolumeMax ()
Gets the route's maximum volume, or 0 if unknown.
Returns | |
---|---|
int |
isConnecting
public boolean isConnecting ()
This method is deprecated.
Use getConnectionState()
instead
Gets whether the route is connecting.
Returns | |
---|---|
boolean |
isDynamicGroupRoute
public boolean isDynamicGroupRoute ()
Returns if this route is a dynamic group route.
MediaRouteProvider
creates a dynamic group route when
MediaRouteProvider.onCreateDynamicGroupRouteController(String)
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
public boolean isEnabled ()
Gets whether the route is enabled.
Returns | |
---|---|
boolean |
isValid
public boolean isValid ()
Returns true if the route descriptor has all of the required fields.
Returns | |
---|---|
boolean |
toString
public String toString ()
Returns | |
---|---|
String |
Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2020-09-30 UTC.