Added in API level 30

RoutingSessionInfo

---

Kotlin |Java

class RoutingSessionInfo : Parcelable

kotlin.Any
↳	android.media.RoutingSessionInfo

Describes a routing session which is created when a media route is selected.

Summary

Nested classes
	Builder Builder class for RoutingSessionInfo.

Constants
static Int	TRANSFER_REASON_APP Indicates that the transfer happened from a non-privileged app.
static Int	TRANSFER_REASON_FALLBACK Indicates that the transfer happened by the default logic without explicit system's or user's request.
static Int	TRANSFER_REASON_SYSTEM_REQUEST Indicates that the transfer happened from within a privileged application.

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	describeContents()
Boolean	equals(other: Any?) 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
MutableList<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.
MutableList<String!>	getSelectableRoutes() Gets the list of IDs of selectable routes for the session.
MutableList<String!>	getSelectedRoutes() Gets the list of IDs of selected routes for the session.
Int	getTransferReason() Returns the transfer reason for this routing session.
MutableList<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()
String	toString()
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<RoutingSessionInfo!>	CREATOR

Constants

TRANSFER_REASON_APP

Added in API level 35

static val TRANSFER_REASON_APP: Int

Indicates that the transfer happened from a non-privileged app.

Value: 2

TRANSFER_REASON_FALLBACK

Added in API level 35

static val TRANSFER_REASON_FALLBACK: Int

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.

Value: 0

TRANSFER_REASON_SYSTEM_REQUEST

Added in API level 35

static val TRANSFER_REASON_SYSTEM_REQUEST: Int

Indicates that the transfer happened from within a privileged application.

Value: 1

Public methods

describeContents

Added in API level 30

fun describeContents(): Int

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 30

fun equals(other: Any?): Boolean

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 return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values 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.
• For any non-null reference value x, x.equals(null) should return false.

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	This value may be null.

Return
Boolean	true if this object is the same as the obj argument; false otherwise.

getClientPackageName

Added in API level 30

fun getClientPackageName(): String

Gets the client package name of the session

Return
String	This value cannot be null.

getControlHints

Added in API level 30

fun getControlHints(): Bundle?

Gets the control hints

Return
Bundle?	This value may be null.

getDeselectableRoutes

Added in API level 30

fun getDeselectableRoutes(): MutableList<String!>

Gets the list of IDs of deselectable routes for the session.

Return
MutableList<String!>	This value cannot be null.

getId

Added in API level 30

fun getId(): String

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.

Return
String	This value cannot be null.

See Also

• android.media.RoutingSessionInfo.Builder#Builder(String, String)

getName

Added in API level 30

fun getName(): CharSequence?

Gets the user-visible name of the session. It may be null.

getSelectableRoutes

Added in API level 30

fun getSelectableRoutes(): MutableList<String!>

Gets the list of IDs of selectable routes for the session.

Return
MutableList<String!>	This value cannot be null.

getSelectedRoutes

Added in API level 30

fun getSelectedRoutes(): MutableList<String!>

Gets the list of IDs of selected routes for the session. It shouldn't be empty.

Return
MutableList<String!>	This value cannot be null.

getTransferReason

Added in API level 35

fun getTransferReason(): Int

Returns the transfer reason for this routing session.

Return
Int	Value is android.media.RoutingSessionInfo#TRANSFER_REASON_FALLBACK, android.media.RoutingSessionInfo#TRANSFER_REASON_SYSTEM_REQUEST, or android.media.RoutingSessionInfo#TRANSFER_REASON_APP

getTransferableRoutes

Added in API level 30

fun getTransferableRoutes(): MutableList<String!>

Gets the list of IDs of transferable routes for the session.

Return
MutableList<String!>	This value cannot be null.

getVolume

Added in API level 30

fun getVolume(): Int

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().

See Also

• android.media.MediaRoute2Info#getVolume()

getVolumeHandling

Added in API level 30

fun getVolumeHandling(): Int

Gets the information about how volume is handled on the session.

Return
Int	MediaRoute2Info#PLAYBACK_VOLUME_FIXED or MediaRoute2Info#PLAYBACK_VOLUME_VARIABLE. Value is android.media.MediaRoute2Info#PLAYBACK_VOLUME_FIXED, or android.media.MediaRoute2Info#PLAYBACK_VOLUME_VARIABLE

getVolumeMax

Added in API level 30

fun getVolumeMax(): Int

Gets the maximum volume of the session.

hashCode

Added in API level 30

fun hashCode(): Int

Return
Int	a hash code value for this object.

toString

Added in API level 30

fun toString(): String

Return
String	a string representation of the object.

writeToParcel

Added in API level 30

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 30

static val CREATOR: Parcelable.Creator<RoutingSessionInfo!>