Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/media/RoutingSessionInfo#nestedclasses) \| [Constants](https://developer.android.com/reference/android/media/RoutingSessionInfo#constants) \| [Inherited Constants](https://developer.android.com/reference/android/media/RoutingSessionInfo#inhconstants) \| [Fields](https://developer.android.com/reference/android/media/RoutingSessionInfo#lfields) \| [Methods](https://developer.android.com/reference/android/media/RoutingSessionInfo#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/RoutingSessionInfo#inhmethods)

# RoutingSessionInfo

*** ** * ** ***

` public final class RoutingSessionInfo `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.media.RoutingSessionInfo |

<br />

*** ** * ** ***

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

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` Builder class for `https://developer.android.com/reference/android/media/RoutingSessionInfo`. |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/media/RoutingSessionInfo#TRANSFER_REASON_APP` Indicates that the transfer happened from a non-privileged app. |
| `int` | `https://developer.android.com/reference/android/media/RoutingSessionInfo#TRANSFER_REASON_FALLBACK` Indicates that the transfer happened by the default logic without explicit system's or user's request. |
| `int` | `https://developer.android.com/reference/android/media/RoutingSessionInfo#TRANSFER_REASON_SYSTEM_REQUEST` Indicates that the transfer happened from within a privileged application. |

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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)`".

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/media/RoutingSessionInfo>` | `https://developer.android.com/reference/android/media/RoutingSessionInfo#CREATOR` <br /> |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#getClientPackageName()() ` Gets the client package name of the session |
| ` https://developer.android.com/reference/android/os/Bundle` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#getControlHints()() ` Gets the control hints |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String>` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#getDeselectableRoutes()() ` Gets the list of IDs of deselectable routes for the session. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#getId()() ` Gets the id of the session. |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#getName()() ` Gets the user-visible name of the session. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String>` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#getSelectableRoutes()() ` Gets the list of IDs of selectable routes for the session. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String>` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#getSelectedRoutes()() ` Gets the list of IDs of selected routes for the session. |
| ` int` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#getTransferReason()() ` Returns the transfer reason for this routing session. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String>` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#getTransferableRoutes()() ` Gets the list of IDs of transferable routes for the session. |
| ` int` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#getVolume()() ` Gets the current volume of the session. |
| ` int` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#getVolumeHandling()() ` Gets the information about how volume is handled on the session. |
| ` int` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#getVolumeMax()() ` Gets the maximum volume of the session. |
| ` int` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#hashCode()() ` Returns a hash code value for the object. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Constants

### TRANSFER_REASON_APP

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int TRANSFER_REASON_APP
```

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

<br />

Constant Value: 2 (0x00000002)

### TRANSFER_REASON_FALLBACK

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

Constant Value: 0 (0x00000000)

### TRANSFER_REASON_SYSTEM_REQUEST

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int TRANSFER_REASON_SYSTEM_REQUEST
```

Indicates that the transfer happened from within a privileged application.

<br />

Constant Value: 1 (0x00000001)

## Fields

### CREATOR

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<RoutingSessionInfo> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### equals

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 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.

<br />

| Parameters ||
|---|---|
| `obj` | `Object`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getClientPackageName

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getClientPackageName ()
```

Gets the client package name of the session

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value cannot be `null`. <br /> |

### getControlHints

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Bundle getControlHints ()
```

Gets the control hints

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/os/Bundle` | This value may be `null`. <br /> |

### getDeselectableRoutes

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public List<String> getDeselectableRoutes ()
```

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

Deselectable routes can be removed from the `https://developer.android.com/reference/android/media/RoutingSessionInfo#getSelectedRoutes()`, so that the routing session stops routing to the newly deselected route, but continues on any remaining selected routes.

Deselectable routes should be a subset of the `https://developer.android.com/reference/android/media/RoutingSessionInfo#getSelectedRoutes()`, meaning not all of the selected routes might be deselectable. For example, one of the selected routes may be a leader device coordinating group playback, which must always remain selected while the session is active.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String>` | A possibly empty list of deselectable route ids. This value cannot be `null`. <br /> |

### getId

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getId ()
```

Gets the id of the session. The sessions which are given by `https://developer.android.com/reference/android/media/MediaRouter2` will have unique IDs.

In order to ensure uniqueness in `https://developer.android.com/reference/android/media/MediaRouter2` side, the value of this method can be different from what was set in `https://developer.android.com/reference/android/media/MediaRoute2ProviderService`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#Builder(java.lang.String,%20java.lang.String)`

### getName

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public CharSequence getName ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | <br /> |

### getSelectableRoutes

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public List<String> getSelectableRoutes ()
```

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

Selectable routes can be added to a routing session (via `https://developer.android.com/reference/android/media/MediaRouter2.RoutingController#selectRoute(android.media.MediaRoute2Info)`) in order to add them to the `https://developer.android.com/reference/android/media/RoutingSessionInfo#getSelectedRoutes()`, so that media plays on the newly selected route along with the other selected routes.

Not to be confused with `https://developer.android.com/reference/android/media/RoutingSessionInfo#getTransferableRoutes()`. Transferring to a route makes it the sole selected route.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String>` | A possibly empty list of selectable route ids. This value cannot be `null`. <br /> |

### getSelectedRoutes

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public List<String> getSelectedRoutes ()
```

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

Selected routes are the routes that this session is actively routing media to.

The behavior of a routing session with multiple selected routes is ultimately defined by the `https://developer.android.com/reference/android/media/MediaRoute2ProviderService` implementation. However, typically, it's expected that all the selected routes of a routing session are playing the same media in sync.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String>` | A non-empty list of selected route ids. This value cannot be `null`. <br /> |

### getTransferReason

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getTransferReason ()
```

Returns the transfer reason for this routing session.

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/media/RoutingSessionInfo#TRANSFER_REASON_FALLBACK` - `https://developer.android.com/reference/android/media/RoutingSessionInfo#TRANSFER_REASON_SYSTEM_REQUEST` - `https://developer.android.com/reference/android/media/RoutingSessionInfo#TRANSFER_REASON_APP` |

### getTransferableRoutes

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public List<String> getTransferableRoutes ()
```

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

Transferring to a route (for example, using `https://developer.android.com/reference/android/media/MediaRouter2#transferTo(android.media.MediaRoute2Info)`) replaces the list of `https://developer.android.com/reference/android/media/RoutingSessionInfo#getSelectedRoutes()` with the target route, causing playback to move from one route to another.

Note that this is different from `https://developer.android.com/reference/android/media/RoutingSessionInfo#getSelectableRoutes()`, because selecting a route makes it part of the selected routes, while transferring to a route makes it the selected route. A route can be both transferable and selectable.

Note that playback may transfer across routes without the target route being in the list of transferable routes. This can happen by creating a new routing session to the target route, and releasing the routing session being transferred from. The difference is that a transfer to a route in the transferable list can happen with no intervention from the app, with the route provider taking care of the entire operation. A transfer to a route that is not in the list of transferable routes (by creating a new session) requires the app to move the playback state from one device to the other.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/String>` | A possibly empty list of transferable route ids. This value cannot be `null`. <br /> |

### getVolume

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/media/MediaRoute2Info#getVolume()`.

<br />

<br />

| Returns ||
|---|---|
| `int` | <br /> |

**See also:**

- `https://developer.android.com/reference/android/media/MediaRoute2Info#getVolume()`

### getVolumeHandling

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getVolumeHandling ()
```

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

<br />

| Returns ||
|---|---|
| `int` | `https://developer.android.com/reference/android/media/MediaRoute2Info#PLAYBACK_VOLUME_FIXED` or `https://developer.android.com/reference/android/media/MediaRoute2Info#PLAYBACK_VOLUME_VARIABLE`. Value is one of the following: - `https://developer.android.com/reference/android/media/MediaRoute2Info#PLAYBACK_VOLUME_FIXED` - `https://developer.android.com/reference/android/media/MediaRoute2Info#PLAYBACK_VOLUME_VARIABLE` |

### getVolumeMax

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getVolumeMax ()
```

Gets the maximum volume of the session.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### hashCode

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/java/util/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 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.
- If two objects are equal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` 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 `https://developer.android.com/reference/java/lang/Object#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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### toString

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |