# CastPlayer.Builder

Artifact: [androidx.media3:media3-cast](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/cast/CastPlayer.java+class:androidx.media3.cast.CastPlayer.Builder)

*** ** * ** ***


```
class CastPlayer.Builder
```

<br />

*** ** * ** ***

Builder for `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer`.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.Builder#Builder(android.content.Context)(context: https://developer.android.com/reference/android/content/Context.html!)` Creates a builder. |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer!` | `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.Builder#build()()` Creates and returns the new `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayerImpl` instance. |
| `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.Builder!` | `@https://checkerframework.org/api/com/google/errorprone/annotations/CanIgnoreReturnValue.html https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.Builder#setLocalPlayer(androidx.media3.common.Player)(localPlayer: https://developer.android.com/reference/kotlin/androidx/media3/common/Player!)` Sets the `https://developer.android.com/reference/kotlin/androidx/media3/common/Player` to use for local playback. |
| `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.Builder!` | `@https://checkerframework.org/api/com/google/errorprone/annotations/CanIgnoreReturnValue.html https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.Builder#setRemotePlayer(androidx.media3.cast.RemoteCastPlayer)(remotePlayer: https://developer.android.com/reference/kotlin/androidx/media3/cast/RemoteCastPlayer!)` Sets the `https://developer.android.com/reference/kotlin/androidx/media3/cast/RemoteCastPlayer` to use for remote playback. |
| `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.Builder!` | `@https://checkerframework.org/api/com/google/errorprone/annotations/CanIgnoreReturnValue.html https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.Builder#setTransferCallback(androidx.media3.cast.CastPlayer.TransferCallback)(transferCallback: https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.TransferCallback!)` Sets the `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.TransferCallback` to call when the active player changes. |

## Public constructors

### Builder

```
Builder(context: Context!)
```

Creates a builder.

The builder uses the following default values:

- `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.TransferCallback`: `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.TransferCallback#DEFAULT()`.
- `https://developer.android.com/reference/kotlin/androidx/media3/cast/RemoteCastPlayer`: `https://developer.android.com/reference/kotlin/androidx/media3/cast/RemoteCastPlayer`.
- `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.Builder#setLocalPlayer(androidx.media3.common.Player)`: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer`.

| Parameters |
|---|---|
| `context: https://developer.android.com/reference/android/content/Context.html!` | A `https://developer.android.com/reference/android/content/Context.html`. |

## Public functions

### build

```
fun build(): CastPlayer!
```

Creates and returns the new `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayerImpl` instance.

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException.html` | If this method has already been called on this instance. |

### setLocalPlayer

```
@CanIgnoreReturnValue
fun setLocalPlayer(localPlayer: Player!): CastPlayer.Builder!
```

Sets the `https://developer.android.com/reference/kotlin/androidx/media3/common/Player` to use for local playback.

| Parameters |
|---|---|
| `localPlayer: https://developer.android.com/reference/kotlin/androidx/media3/common/Player!` | A `https://developer.android.com/reference/kotlin/androidx/media3/common/Player`. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.Builder!` | This builder. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException.html` | If `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.Builder#build()` has already been called on this builder instance. |

### setRemotePlayer

```
@CanIgnoreReturnValue
fun setRemotePlayer(remotePlayer: RemoteCastPlayer!): CastPlayer.Builder!
```

Sets the `https://developer.android.com/reference/kotlin/androidx/media3/cast/RemoteCastPlayer` to use for remote playback.

| Parameters |
|---|---|
| `remotePlayer: https://developer.android.com/reference/kotlin/androidx/media3/cast/RemoteCastPlayer!` | A `https://developer.android.com/reference/kotlin/androidx/media3/cast/RemoteCastPlayer`. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.Builder!` | This builder. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException.html` | If `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.Builder#build()` has already been called on this builder instance. |

### setTransferCallback

```
@CanIgnoreReturnValue
fun setTransferCallback(transferCallback: CastPlayer.TransferCallback!): CastPlayer.Builder!
```

Sets the `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.TransferCallback` to call when the active player changes.

| Parameters |
|---|---|
| `transferCallback: https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.TransferCallback!` | A `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.TransferCallback`. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.Builder!` | This builder. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException.html` | If `https://developer.android.com/reference/kotlin/androidx/media3/cast/CastPlayer.Builder#build()` has already been called on this builder instance. |