RoutingSessionInfo
public
final
class
RoutingSessionInfo
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.media.RoutingSessionInfo |
Describes a routing session which is created when a media route is selected.
Summary
Nested classes | |
---|---|
class |
RoutingSessionInfo.Builder
Builder class for |
Constants | |
---|---|
int |
TRANSFER_REASON_APP
Indicates that the transfer happened from a non-privileged app. |
int |
TRANSFER_REASON_FALLBACK
Indicates that the transfer happened by the default logic without explicit system's or user's request. |
int |
TRANSFER_REASON_SYSTEM_REQUEST
Indicates that the transfer happened from within a privileged application. |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<RoutingSessionInfo> |
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 client package name of the session |
Bundle
|
getControlHints()
Gets the control hints |
List<String>
|
getDeselectableRoutes()
Gets the list of IDs of deselectable routes for the session. |
String
|
getId()
Gets the id of the session. |
CharSequence
|
getName()
Gets the user-visible name of the session. |
List<String>
|
getSelectableRoutes()
Gets the list of IDs of selectable routes for the session. |
List<String>
|
getSelectedRoutes()
Gets the list of IDs of selected routes for the session. |
int
|
getTransferReason()
Returns the transfer reason for this routing session. |
List<String>
|
getTransferableRoutes()
Gets the list of IDs of transferable routes for the session. |
int
|
getVolume()
Gets the current volume of the session. |
int
|
getVolumeHandling()
Gets the information about how volume is handled on the session. |
int
|
getVolumeMax()
Gets the maximum volume of the session. |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Constants
TRANSFER_REASON_APP
public static final int TRANSFER_REASON_APP
Indicates that the transfer happened from a non-privileged app.
Constant Value: 2 (0x00000002)
TRANSFER_REASON_FALLBACK
public static final int TRANSFER_REASON_FALLBACK
Indicates that the transfer happened by the default logic without explicit system's or user's request.
For example, an automatically connected Bluetooth device will have this transfer reason.
Constant Value: 0 (0x00000000)
TRANSFER_REASON_SYSTEM_REQUEST
public static final int TRANSFER_REASON_SYSTEM_REQUEST
Indicates that the transfer happened from within a privileged application.
Constant Value: 1 (0x00000001)
Fields
Public methods
describeContents
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 |
equals
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:
- It is reflexive: for any non-null reference value
x
,x.equals(x)
should returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
Parameters | |
---|---|
obj |
Object : This value may be null . |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getClientPackageName
public String getClientPackageName ()
Gets the client package name of the session
Returns | |
---|---|
String |
This value cannot be null . |
getControlHints
public Bundle getControlHints ()
Gets the control hints
Returns | |
---|---|
Bundle |
This value may be null . |
getDeselectableRoutes
public List<String> getDeselectableRoutes ()
Gets the list of IDs of deselectable routes for the session.
Returns | |
---|---|
List<String> |
This value cannot be null . |
getId
public String getId ()
Gets the id of the session. The sessions 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 . |
getName
public CharSequence getName ()
Gets the user-visible name of the session. It may be null
.
Returns | |
---|---|
CharSequence |
getSelectableRoutes
public List<String> getSelectableRoutes ()
Gets the list of IDs of selectable routes for the session.
Returns | |
---|---|
List<String> |
This value cannot be null . |
getSelectedRoutes
public List<String> getSelectedRoutes ()
Gets the list of IDs of selected routes for the session. It shouldn't be empty.
Returns | |
---|---|
List<String> |
This value cannot be null . |
getTransferReason
public int getTransferReason ()
Returns the transfer reason for this routing session.
Returns | |
---|---|
int |
Value is TRANSFER_REASON_FALLBACK , TRANSFER_REASON_SYSTEM_REQUEST , or TRANSFER_REASON_APP |
getTransferableRoutes
public List<String> getTransferableRoutes ()
Gets the list of IDs of transferable routes for the session.
Returns | |
---|---|
List<String> |
This value cannot be null . |
getVolume
public int getVolume ()
Gets the current volume of the session.
When it's available, it represents the volume of routing session, which is a group
of selected routes. To get the volume of each route, use MediaRoute2Info#getVolume()
.
Returns | |
---|---|
int |
See also:
getVolumeHandling
public int getVolumeHandling ()
Gets the information about how volume is handled on the session.
Returns | |
---|---|
int |
MediaRoute2Info#PLAYBACK_VOLUME_FIXED or
MediaRoute2Info#PLAYBACK_VOLUME_VARIABLE .
Value is MediaRoute2Info.PLAYBACK_VOLUME_FIXED , or MediaRoute2Info.PLAYBACK_VOLUME_VARIABLE |
getVolumeMax
public int getVolumeMax ()
Gets the maximum volume of the session.
Returns | |
---|---|
int |
hashCode
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:
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
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. - If two objects are equal according to the
equals
method, then calling thehashCode
method on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
equals
method, then calling thehashCode
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.
Returns | |
---|---|
int |
a hash code value for this object. |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |
writeToParcel
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 |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-06-18 UTC.