PlayerTransferState

Kotlin |Java

@UnstableApi
class PlayerTransferState

Holds a snapshot of a player's transferable state.

We define transferable state to be state that should be carried over from one player to another when transferring playback. For example, the media playlist and the playback position are part of the transferable state. However, the buffering position is part of the player's state but it's not state we carry over when moving playback.

This class is useful when moving playback across devices. For example, across an Android device and a Cast receiver.

Summary

Nested types
`class PlayerTransferState.Builder` Builder for `PlayerTransferState`.

Public functions
`PlayerTransferState.Builder!`	`buildUpon()` Returns a `Builder` pre-populated with the current state values.
`java-static PlayerTransferState.Builder!`	`builderFromPlayer(player: Player!)` Creates a new `Builder` that's pre-populated with the values from the given `Player`.
`Boolean`	`equals(o: Any?)`
`java-static PlayerTransferState!`	`fromPlayer(player: Player!)` Equivalent to `builderFromPlayer(player).build()`.
`Int`	`hashCode()`
`Unit`	`setToPlayer(player: Player!)` Applies this state to a given `Player` instance by calling the corresponding setters.

Public properties
`Int`	`currentMediaItemIndex`
`Long`	`currentPosition`
`ImmutableList<MediaItem!>!`	`mediaItems`
`Boolean`	`playWhenReady`
`PlaybackParameters!`	`playbackParameters`
`Int`	`repeatMode`
`Boolean`	`shuffleModeEnabled`
`TrackSelectionParameters!`	`trackSelectionParameters`

Public functions

buildUpon

fun buildUpon(): PlayerTransferState.Builder!

Returns a Builder pre-populated with the current state values.

builderFromPlayer

java-static fun builderFromPlayer(player: Player!): PlayerTransferState.Builder!

Creates a new Builder that's pre-populated with the values from the given Player.

Parameters
`player: Player!`	The `Player` instance to populate the builder from.

Returns
`PlayerTransferState.Builder!`	A new `Builder` instance populated with the given player's current state.

equals

fun equals(o: Any?): Boolean

fromPlayer

java-static fun fromPlayer(player: Player!): PlayerTransferState!

Equivalent to builderFromPlayer(player).build().

Returns
`PlayerTransferState!`	A `PlayerTransferState` whose contents are populated with the state from the given `Player`.

hashCode

fun hashCode(): Int

setToPlayer

fun setToPlayer(player: Player!): Unit

Applies this state to a given Player instance by calling the corresponding setters.

Parameters
`player: Player!`	The `Player` instance to which the state should be applied.

Public properties

currentMediaItemIndex

val currentMediaItemIndex: Int

currentPosition

val currentPosition: Long

mediaItems

val mediaItems: ImmutableList<MediaItem!>!

playWhenReady

val playWhenReady: Boolean

playbackParameters

val playbackParameters: PlaybackParameters!

repeatMode

val repeatMode: Int

shuffleModeEnabled

val shuffleModeEnabled: Boolean

trackSelectionParameters

val trackSelectionParameters: TrackSelectionParameters!

PlayerTransferState

Summary

Nested types

Public functions

Public properties

Public functions

buildUpon

builderFromPlayer

equals

fromPlayer

hashCode

setToPlayer

Public properties

currentMediaItemIndex

currentPosition

mediaItems

playWhenReady

playbackParameters

repeatMode

shuffleModeEnabled

trackSelectionParameters