Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#pubctors) \| [Methods](https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#inhmethods)

# RoutingSessionInfo.Builder

*** ** * ** ***


`
public
static
final

class
RoutingSessionInfo.Builder
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


`

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

<br />

*** ** * ** ***

Builder class for `https://developer.android.com/reference/android/media/RoutingSessionInfo`.

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#Builder(android.media.RoutingSessionInfo)(https://developer.android.com/reference/android/media/RoutingSessionInfo sessionInfo) ` Constructor for builder to create `https://developer.android.com/reference/android/media/RoutingSessionInfo` with existing `https://developer.android.com/reference/android/media/RoutingSessionInfo` instance. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#Builder(java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String originalId, https://developer.android.com/reference/java/lang/String clientPackageName) ` Constructor for builder to create `https://developer.android.com/reference/android/media/RoutingSessionInfo`. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#addDeselectableRoute(java.lang.String)(https://developer.android.com/reference/java/lang/String routeId) ` Adds a route to the deselectable routes. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#addSelectableRoute(java.lang.String)(https://developer.android.com/reference/java/lang/String routeId) ` Adds a route to the selectable routes. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#addSelectedRoute(java.lang.String)(https://developer.android.com/reference/java/lang/String routeId) ` Adds a route to the selected routes. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#addTransferableRoute(java.lang.String)(https://developer.android.com/reference/java/lang/String routeId) ` Adds a route to the transferable routes. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#build()() ` Builds a routing session info. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#clearDeselectableRoutes()() ` Clears the deselectable routes. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#clearSelectableRoutes()() ` Clears the selectable routes. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#clearSelectedRoutes()() ` Clears the selected routes. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#clearTransferableRoutes()() ` Clears the transferable routes. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#removeDeselectableRoute(java.lang.String)(https://developer.android.com/reference/java/lang/String routeId) ` Removes a route from the deselectable routes. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#removeSelectableRoute(java.lang.String)(https://developer.android.com/reference/java/lang/String routeId) ` Removes a route from the selectable routes. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#removeSelectedRoute(java.lang.String)(https://developer.android.com/reference/java/lang/String routeId) ` Removes a route from the selected routes. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#removeTransferableRoute(java.lang.String)(https://developer.android.com/reference/java/lang/String routeId) ` Removes a route from the transferable routes. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#setControlHints(android.os.Bundle)(https://developer.android.com/reference/android/os/Bundle controlHints) ` Sets control hints. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#setName(java.lang.CharSequence)(https://developer.android.com/reference/java/lang/CharSequence name) ` Sets the user-visible name of the session. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#setTransferInitiator(android.os.UserHandle,%20java.lang.String)(https://developer.android.com/reference/android/os/UserHandle transferInitiatorUserHandle, https://developer.android.com/reference/java/lang/String transferInitiatorPackageName) ` Sets the user handle and package name of the process that initiated the transfer. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#setTransferReason(int)(int transferReason) ` Sets transfer reason for the current session. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#setVolume(int)(int volume) ` Sets the session's current volume, or 0 if unknown. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#setVolumeHandling(int)(int volumeHandling) ` Sets the session's volume handling. |
| ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | ` https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder#setVolumeMax(int)(int volumeMax) ` Sets the session's maximum volume, or 0 if unknown. |

| ### 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*. | ||

## Public constructors

### Builder

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

```
public Builder (RoutingSessionInfo sessionInfo)
```

Constructor for builder to create `https://developer.android.com/reference/android/media/RoutingSessionInfo` with
existing `https://developer.android.com/reference/android/media/RoutingSessionInfo` instance.

<br />

| Parameters ||
|---|---|
| `sessionInfo` | `RoutingSessionInfo`: the existing instance to copy data from. This value cannot be `null`. <br /> |

### Builder

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

```
public Builder (String originalId, 
                String clientPackageName)
```

Constructor for builder to create `https://developer.android.com/reference/android/media/RoutingSessionInfo`.

In order to ensure ID uniqueness in `https://developer.android.com/reference/android/media/MediaRouter2` side, the value of `https://developer.android.com/reference/android/media/RoutingSessionInfo#getId()` can be different from what was set in `https://developer.android.com/reference/android/media/MediaRoute2ProviderService`.

<br />

| Parameters ||
|---|---|
| `originalId` | `String`: ID of the session. Must not be empty. This value cannot be `null`. <br /> |
| `clientPackageName` | `String`: package name of the client app which uses this session. If is is unknown, then just use an empty string. This value cannot be `null`. <br /> |

**See also:**

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

## Public methods

### addDeselectableRoute

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

```
public RoutingSessionInfo.Builder addDeselectableRoute (String routeId)
```

Adds a route to the deselectable routes. The `routeId` must not be empty.

<br />

| Parameters ||
|---|---|
| `routeId` | `String`: This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### addSelectableRoute

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

```
public RoutingSessionInfo.Builder addSelectableRoute (String routeId)
```

Adds a route to the selectable routes. The `routeId` must not be empty.

<br />

| Parameters ||
|---|---|
| `routeId` | `String`: This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### addSelectedRoute

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

```
public RoutingSessionInfo.Builder addSelectedRoute (String routeId)
```

Adds a route to the selected routes. The `routeId` must not be empty.

<br />

| Parameters ||
|---|---|
| `routeId` | `String`: This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### addTransferableRoute

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

```
public RoutingSessionInfo.Builder addTransferableRoute (String routeId)
```

Adds a route to the transferable routes. The `routeId` must not be empty.

<br />

| Parameters ||
|---|---|
| `routeId` | `String`: This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### build

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

```
public RoutingSessionInfo build ()
```

Builds a routing session info.

<br />

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

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if no selected routes are added. |

### clearDeselectableRoutes

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

```
public RoutingSessionInfo.Builder clearDeselectableRoutes ()
```

Clears the deselectable routes.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### clearSelectableRoutes

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

```
public RoutingSessionInfo.Builder clearSelectableRoutes ()
```

Clears the selectable routes.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### clearSelectedRoutes

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

```
public RoutingSessionInfo.Builder clearSelectedRoutes ()
```

Clears the selected routes.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### clearTransferableRoutes

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

```
public RoutingSessionInfo.Builder clearTransferableRoutes ()
```

Clears the transferable routes.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### removeDeselectableRoute

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

```
public RoutingSessionInfo.Builder removeDeselectableRoute (String routeId)
```

Removes a route from the deselectable routes. The `routeId` must not be empty.

<br />

| Parameters ||
|---|---|
| `routeId` | `String`: This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### removeSelectableRoute

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

```
public RoutingSessionInfo.Builder removeSelectableRoute (String routeId)
```

Removes a route from the selectable routes. The `routeId` must not be empty.

<br />

| Parameters ||
|---|---|
| `routeId` | `String`: This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### removeSelectedRoute

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

```
public RoutingSessionInfo.Builder removeSelectedRoute (String routeId)
```

Removes a route from the selected routes. The `routeId` must not be empty.

<br />

| Parameters ||
|---|---|
| `routeId` | `String`: This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### removeTransferableRoute

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

```
public RoutingSessionInfo.Builder removeTransferableRoute (String routeId)
```

Removes a route from the transferable routes. The `routeId` must not be empty.

<br />

| Parameters ||
|---|---|
| `routeId` | `String`: This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### setControlHints

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

```
public RoutingSessionInfo.Builder setControlHints (Bundle controlHints)
```

Sets control hints.

<br />

| Parameters ||
|---|---|
| `controlHints` | `Bundle`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### setName

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

```
public RoutingSessionInfo.Builder setName (CharSequence name)
```

Sets the user-visible name of the session.

<br />

| Parameters ||
|---|---|
| `name` | `CharSequence`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### setTransferInitiator

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

```
public RoutingSessionInfo.Builder setTransferInitiator (UserHandle transferInitiatorUserHandle, 
                String transferInitiatorPackageName)
```

Sets the user handle and package name of the process that initiated the transfer.

By default the transfer initiation user handle and package name are set to `null`.

<br />

| Parameters ||
|---|---|
| `transferInitiatorUserHandle` | `UserHandle`: This value may be `null`. <br /> |
| `transferInitiatorPackageName` | `String`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | <br /> |

### setTransferReason

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

```
public RoutingSessionInfo.Builder setTransferReason (int transferReason)
```

Sets transfer reason for the current session.

By default the transfer reason is set to `https://developer.android.com/reference/android/media/RoutingSessionInfo#TRANSFER_REASON_FALLBACK`.

<br />

| Parameters ||
|---|---|
| `transferReason` | `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` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### setVolume

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

```
public RoutingSessionInfo.Builder setVolume (int volume)
```

Sets the session's current volume, or 0 if unknown.

<br />

| Parameters ||
|---|---|
| `volume` | `int` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### setVolumeHandling

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

```
public RoutingSessionInfo.Builder setVolumeHandling (int volumeHandling)
```

Sets the session's volume handling. `https://developer.android.com/reference/android/media/MediaRoute2Info#PLAYBACK_VOLUME_FIXED` or
`https://developer.android.com/reference/android/media/MediaRoute2Info#PLAYBACK_VOLUME_VARIABLE`.

<br />

| Parameters ||
|---|---|
| `volumeHandling` | `int`: 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` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |

### setVolumeMax

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

```
public RoutingSessionInfo.Builder setVolumeMax (int volumeMax)
```

Sets the session's maximum volume, or 0 if unknown.

<br />

| Parameters ||
|---|---|
| `volumeMax` | `int` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RoutingSessionInfo.Builder` | This value cannot be `null`. <br /> |