# Print output for @column tags ?>
public
final
class
MediaRoute2Info
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.media.MediaRoute2Info |
Describes the properties of a route.
Nested classes | |
---|---|
class |
MediaRoute2Info.Builder
Builder for |
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. |
String |
FEATURE_LIVE_AUDIO
Route feature: Live audio. |
String |
FEATURE_LIVE_VIDEO
Route feature: Live video. |
String |
FEATURE_REMOTE_AUDIO_PLAYBACK
Route feature: Remote audio playback. |
String |
FEATURE_REMOTE_PLAYBACK
Route feature: Remote playback. |
String |
FEATURE_REMOTE_VIDEO_PLAYBACK
Route feature: Remote video playback. |
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. |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<MediaRoute2Info> |
CREATOR
|
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
String
|
getClientPackageName()
Gets the package name of the app using the route. |
int
|
getConnectionState()
Gets the connection state of the route. |
CharSequence
|
getDescription()
Gets the user-visible description of the route. |
Bundle
|
getExtras()
|
List<String>
|
getFeatures()
Gets the supported features of the route. |
Uri
|
getIconUri()
Gets the URI of the icon representing this route. |
String
|
getId()
Gets the id of the route. |
CharSequence
|
getName()
Gets the user-visible name of the route. |
int
|
getVolume()
Gets the current volume of the route. |
int
|
getVolumeHandling()
Gets information about how volume is handled on the route. |
int
|
getVolumeMax()
Gets the maximum volume of the route. |
int
|
hashCode()
Returns a hash code value for the object. |
boolean
|
isSystemRoute()
Returns whether the route is a system route or not. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
public static final int CONNECTION_STATE_CONNECTED
A connection state indicating the route is connected.
See also:
Constant Value: 2 (0x00000002)
public static final int CONNECTION_STATE_CONNECTING
A connection state indicating the route is in the process of connecting and is not yet ready for use.
See also:
Constant Value: 1 (0x00000001)
public static final int CONNECTION_STATE_DISCONNECTED
The default connection state indicating the route is disconnected.
See also:
Constant Value: 0 (0x00000000)
public static final String FEATURE_LIVE_AUDIO
Route feature: Live audio.
A route that supports live audio routing will allow the media audio stream to be sent to supported destinations. This can include internal speakers or audio jacks on the device itself, A2DP devices, and more.
When a live audio route is selected, audio routing is transparent to the application. All audio played on the media stream will be routed to the selected destination.
Refer to the class documentation for details about live audio routes.
Constant Value: "android.media.route.feature.LIVE_AUDIO"
public static final String FEATURE_LIVE_VIDEO
Route feature: Live video.
A route that supports live video routing will allow a mirrored version
of the device's primary display or a customized
Presentation
to be sent to supported
destinations.
When a live video route is selected, audio and video routing is transparent
to the application. By default, audio and video is routed to the selected
destination. For certain live video routes, the application may also use a
Presentation
to replace the mirrored view
on the external display with different content.
Refer to the class documentation for details about live video routes.
See also:
Constant Value: "android.media.route.feature.LIVE_VIDEO"
public static final String FEATURE_REMOTE_AUDIO_PLAYBACK
Route feature: Remote audio playback.
A route that supports remote audio playback routing will allow an application to send requests to play audio content remotely to supported destinations.
Constant Value: "android.media.route.feature.REMOTE_AUDIO_PLAYBACK"
public static final String FEATURE_REMOTE_PLAYBACK
Route feature: Remote playback.
A route that supports remote playback routing will allow an application to send
requests to play content remotely to supported destinations.
A route may only support audio playback
or
video playback
.
Remote playback routes destinations operate independently of the local device.
When a remote playback route is selected, the application can control the content
playing on the destination using MediaRouter2.RoutingController#getControlHints()
.
The application may also receive status updates from the route regarding remote playback.
Refer to the class documentation for details about remote playback routes.
Constant Value: "android.media.route.feature.REMOTE_PLAYBACK"
public static final String FEATURE_REMOTE_VIDEO_PLAYBACK
Route feature: Remote video playback.
A route that supports remote video playback routing will allow an application to send requests to play video content remotely to supported destinations.
Constant Value: "android.media.route.feature.REMOTE_VIDEO_PLAYBACK"
public static final 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)
public static final 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)
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(android.os.Parcel, int)
,
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR
bit.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
public boolean equals (Object obj)
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
x
and y
, multiple invocations of
x.equals(y)
consistently return true
or consistently return false
, provided no
information used in equals
comparisons on the
objects is modified.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
Parameters | |
---|---|
obj |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
public String getClientPackageName ()
Gets the package name of the app using the route. Returns null if no apps are using this route.
Returns | |
---|---|
String |
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 .
Value is CONNECTION_STATE_DISCONNECTED , CONNECTION_STATE_CONNECTING , or CONNECTION_STATE_CONNECTED |
public CharSequence getDescription ()
Gets the user-visible description of the route.
Returns | |
---|---|
CharSequence |
This value may be null . |
public List<String> getFeatures ()
Gets the supported features of the route.
Returns | |
---|---|
List<String> |
This value cannot be null . |
public 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. |
public String getId ()
Gets the id of the route. The routes which are given by MediaRouter2
will have
unique IDs.
In order to ensure uniqueness in MediaRouter2
side, the value of this method
can be different from what was set in MediaRoute2ProviderService
.
Returns | |
---|---|
String |
This value cannot be null . |
public CharSequence getName ()
Gets the user-visible name of the route.
Returns | |
---|---|
CharSequence |
This value cannot be null . |
public int getVolume ()
Gets the current volume of the route. This may be invalid if the route is not selected.
Returns | |
---|---|
int |
public int getVolumeHandling ()
Gets information about how volume is handled on the route.
Returns | |
---|---|
int |
PLAYBACK_VOLUME_FIXED or PLAYBACK_VOLUME_VARIABLE
Value is PLAYBACK_VOLUME_FIXED , or PLAYBACK_VOLUME_VARIABLE |
public int getVolumeMax ()
Gets the maximum volume of the route.
Returns | |
---|---|
int |
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
HashMap
.
The general contract of hashCode
is:
hashCode
method
must consistently return the same integer, provided no information
used in equals
comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
equals(java.lang.Object)
method, then calling the hashCode
method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by
class Object
does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
Returns | |
---|---|
int |
a hash code value for this object. |
public boolean isSystemRoute ()
Returns whether the route is a system route or not.
System routes are media routes directly controlled by the system such as phone speaker, wired headset, and Bluetooth devices.
Returns | |
---|---|
boolean |
public 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. |
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
Parcel : This value cannot be null . |
flags |
int : Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |