PlayerTransferState
@UnstableApi
public final 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 |
|---|
public final class PlayerTransferState.BuilderBuilder for |
Public fields |
|
|---|---|
final int |
|
final long |
|
final ImmutableList<MediaItem> |
|
final boolean |
|
final PlaybackParameters |
|
final int |
|
final boolean |
|
final TrackSelectionParameters |
Public methods |
|
|---|---|
PlayerTransferState.Builder |
Returns a |
static PlayerTransferState.Builder |
builderFromPlayer(Player player)Creates a new |
boolean |
|
static PlayerTransferState |
fromPlayer(Player player)Equivalent to |
int |
Returns the |
long |
Returns the |
ImmutableList<MediaItem> |
Returns the |
boolean |
Returns the |
PlaybackParameters |
Returns the |
int |
Returns the |
boolean |
Returns the |
TrackSelectionParameters |
Returns the |
int |
hashCode() |
void |
setToPlayer(Player player)Applies this state to a given |
Public fields
Public methods
buildUpon
public PlayerTransferState.Builder buildUpon()
Returns a Builder pre-populated with the current state values.
builderFromPlayer
public static PlayerTransferState.Builder builderFromPlayer(Player player)
Creates a new Builder that's pre-populated with the values from the given Player.
| Returns | |
|---|---|
PlayerTransferState.Builder |
A new |
fromPlayer
public static PlayerTransferState fromPlayer(Player player)
Equivalent to builderFromPlayer(player).build().
| Returns | |
|---|---|
PlayerTransferState |
A |
getCurrentMediaItemIndex
public int getCurrentMediaItemIndex()
Returns the current media item index.
getPlaybackParameters
public PlaybackParameters getPlaybackParameters()
Returns the playback parameters.
getShuffleModeEnabled
public boolean getShuffleModeEnabled()
Returns the shuffle mode enabled value.
getTrackSelectionParameters
public TrackSelectionParameters getTrackSelectionParameters()
Returns the track selection parameters.
setToPlayer
public void setToPlayer(Player player)
Applies this state to a given Player instance by calling the corresponding setters.