SimpleBasePlayer.State.Builder

public Builder()

Creates the builder.

public SimpleBasePlayer.State build()

Builds the State.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder clearPositionDiscontinuity()

Clears a previously set position discontinuity signal.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setAdBufferedPositionMs(
    SimpleBasePlayer.PositionSupplier adBufferedPositionMsSupplier
)

Sets the PositionSupplier for the estimated position up to which the currently playing ad is buffered, in milliseconds. The value is unused if no ad is playing.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setAdPositionMs(
    SimpleBasePlayer.PositionSupplier adPositionMsSupplier
)

Sets the PositionSupplier for the current ad playback position in milliseconds. The value is unused if no ad is playing.

The supplier is expected to return the updated position on every call if the playback is advancing, for example by using getExtrapolating.

This method overrides any other position set via setAdPositionMs.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setAdPositionMs(long positionMs)

Sets the current ad playback position in milliseconds. The value is unused if no ad is playing.

This position will be converted to an advancing PositionSupplier if the overall state indicates an advancing ad playback position.

This method overrides any other PositionSupplier set via setAdPositionMs.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setAudioAttributes(AudioAttributes audioAttributes)

Sets the current AudioAttributes.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setAvailableCommands(Player.Commands availableCommands)

Sets the available Commands.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setContentBufferedPositionMs(
    SimpleBasePlayer.PositionSupplier contentBufferedPositionMsSupplier
)

Sets the PositionSupplier for the estimated position up to which the currently playing content is buffered, in milliseconds.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setContentPositionMs(
    SimpleBasePlayer.PositionSupplier contentPositionMsSupplier
)

Sets the PositionSupplier for the current content playback position in milliseconds.

The supplier is expected to return the updated position on every call if the playback is advancing, for example by using getExtrapolating.

This method overrides any other position set via setContentPositionMs.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setContentPositionMs(long positionMs)

Sets the current content playback position in milliseconds.

This position will be converted to an advancing PositionSupplier if the overall state indicates an advancing playback position.

This method overrides any other PositionSupplier set via setContentPositionMs.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setCurrentAd(int adGroupIndex, int adIndexInAdGroup)

Sets the current ad indices, or INDEX_UNSET if no ad is playing.

Either both indices need to be INDEX_UNSET or both are not INDEX_UNSET.

Ads indices can only be set if there is a corresponding AdPlaybackState defined in the current period.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setCurrentCues(CueGroup currentCues)

Sets the current cues.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setCurrentMediaItemIndex(int currentMediaItemIndex)

Sets the current media item index.

The media item index must be less than the number of media items in the playlist, if set.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setDeviceInfo(DeviceInfo deviceInfo)

Sets the DeviceInfo.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setDeviceVolume(@IntRange(from = 0) int deviceVolume)

Sets the current device volume.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setIsDeviceMuted(boolean isDeviceMuted)

Sets whether the device is muted.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setIsLoading(boolean isLoading)

Sets whether the player is currently loading its source.

The player can not be marked as loading if the state is STATE_IDLE or STATE_ENDED.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setMaxSeekToPreviousPositionMs(long maxSeekToPreviousPositionMs)

Sets the maximum position for which seekToPrevious seeks to the previous item, in milliseconds.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setNewlyRenderedFirstFrame(boolean newlyRenderedFirstFrame)

Sets whether a frame has been rendered for the first time since setting the surface, a rendering reset, or since the stream being rendered was changed.

Note: As this will trigger a onRenderedFirstFrame event, the flag should only be set for the first State update after the first frame was rendered.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setPlayWhenReady(
    boolean playWhenReady,
    @Player.PlayWhenReadyChangeReason int playWhenReadyChangeReason
)

Sets whether playback should proceed when ready and not suppressed.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setPlaybackParameters(PlaybackParameters playbackParameters)

Sets the currently active PlaybackParameters.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setPlaybackState(@Player.State int playbackState)

Sets the state of the player.

If the playlist is empty, the state must be either STATE_IDLE or STATE_ENDED.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setPlaybackSuppressionReason(
    @Player.PlaybackSuppressionReason int playbackSuppressionReason
)

Sets the reason why playback is suppressed even if getPlayWhenReady is true.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setPlayerError(@Nullable PlaybackException playerError)

Sets last error that caused playback to fail, or null if there was no error.

The playback state must be set to STATE_IDLE while an error is set.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setPlaylist(List<SimpleBasePlayer.MediaItemData> playlist)

Sets the list of media items in the playlist.

All items must have unique UIDs.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setPlaylistMetadata(MediaMetadata playlistMetadata)

Sets the playlist MediaMetadata.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setPositionDiscontinuity(
    @Player.DiscontinuityReason int positionDiscontinuityReason,
    long discontinuityPositionMs
)

Signals that a position discontinuity happened since the last player update and sets the reason for it.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setRepeatMode(@Player.RepeatMode int repeatMode)

Sets the RepeatMode used for playback.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setSeekBackIncrementMs(long seekBackIncrementMs)

Sets the seekBack increment in milliseconds.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setSeekForwardIncrementMs(long seekForwardIncrementMs)

Sets the seekForward increment in milliseconds.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setShuffleModeEnabled(boolean shuffleModeEnabled)

Sets whether shuffling of media items is enabled.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setSurfaceSize(Size surfaceSize)

Sets the size of the surface onto which the video is being rendered.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setTimedMetadata(Metadata timedMetadata)

Sets the most recent timed Metadata.

Metadata with a presentationTimeUs of TIME_UNSET will not be forwarded to listeners.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setTotalBufferedDurationMs(
    SimpleBasePlayer.PositionSupplier totalBufferedDurationMsSupplier
)

Sets the PositionSupplier for the estimated total buffered duration in milliseconds.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setTrackSelectionParameters(
    TrackSelectionParameters trackSelectionParameters
)

Sets the currently active TrackSelectionParameters.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setVideoSize(VideoSize videoSize)

Sets the current video size.

@CanIgnoreReturnValue
public SimpleBasePlayer.State.Builder setVolume(@FloatRange(from = 0, to = 1.0) float volume)

Sets the current audio volume, with 0 being silence and 1 being unity gain (signal unchanged).