SimpleBasePlayer.State.Builder

Builder()

Creates the builder.

fun build(): SimpleBasePlayer.State!

Builds the State.

@CanIgnoreReturnValue
fun clearPositionDiscontinuity(): SimpleBasePlayer.State.Builder!

Clears a previously set position discontinuity signal.

@CanIgnoreReturnValue
fun setAdBufferedPositionMs(
    adBufferedPositionMsSupplier: SimpleBasePlayer.PositionSupplier!
): SimpleBasePlayer.State.Builder!

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
fun setAdPositionMs(
    adPositionMsSupplier: SimpleBasePlayer.PositionSupplier!
): SimpleBasePlayer.State.Builder!

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
fun setAdPositionMs(positionMs: Long): SimpleBasePlayer.State.Builder!

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
fun setAudioAttributes(audioAttributes: AudioAttributes!): SimpleBasePlayer.State.Builder!

Sets the current AudioAttributes.

@CanIgnoreReturnValue
fun setAvailableCommands(availableCommands: Player.Commands!): SimpleBasePlayer.State.Builder!

Sets the available Commands.

@CanIgnoreReturnValue
fun setContentBufferedPositionMs(
    contentBufferedPositionMsSupplier: SimpleBasePlayer.PositionSupplier!
): SimpleBasePlayer.State.Builder!

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

@CanIgnoreReturnValue
fun setContentPositionMs(
    contentPositionMsSupplier: SimpleBasePlayer.PositionSupplier!
): SimpleBasePlayer.State.Builder!

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
fun setContentPositionMs(positionMs: Long): SimpleBasePlayer.State.Builder!

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
fun setCurrentAd(adGroupIndex: Int, adIndexInAdGroup: Int): SimpleBasePlayer.State.Builder!

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
fun setCurrentCues(currentCues: CueGroup!): SimpleBasePlayer.State.Builder!

Sets the current cues.

@CanIgnoreReturnValue
fun setCurrentMediaItemIndex(currentMediaItemIndex: Int): SimpleBasePlayer.State.Builder!

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
fun setDeviceInfo(deviceInfo: DeviceInfo!): SimpleBasePlayer.State.Builder!

Sets the DeviceInfo.

@CanIgnoreReturnValue
fun setDeviceVolume(deviceVolume: @IntRange(from = 0) Int): SimpleBasePlayer.State.Builder!

Sets the current device volume.

@CanIgnoreReturnValue
fun setIsDeviceMuted(isDeviceMuted: Boolean): SimpleBasePlayer.State.Builder!

Sets whether the device is muted.

@CanIgnoreReturnValue
fun setIsLoading(isLoading: Boolean): SimpleBasePlayer.State.Builder!

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
fun setMaxSeekToPreviousPositionMs(maxSeekToPreviousPositionMs: Long): SimpleBasePlayer.State.Builder!

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

@CanIgnoreReturnValue
fun setNewlyRenderedFirstFrame(newlyRenderedFirstFrame: Boolean): SimpleBasePlayer.State.Builder!

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
fun setPlayWhenReady(
    playWhenReady: Boolean,
    @Player.PlayWhenReadyChangeReason playWhenReadyChangeReason: Int
): SimpleBasePlayer.State.Builder!

Sets whether playback should proceed when ready and not suppressed.

@CanIgnoreReturnValue
fun setPlaybackParameters(playbackParameters: PlaybackParameters!): SimpleBasePlayer.State.Builder!

Sets the currently active PlaybackParameters.

@CanIgnoreReturnValue
fun setPlaybackState(@Player.State playbackState: Int): SimpleBasePlayer.State.Builder!

Sets the state of the player.

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

@CanIgnoreReturnValue
fun setPlaybackSuppressionReason(
    @Player.PlaybackSuppressionReason playbackSuppressionReason: Int
): SimpleBasePlayer.State.Builder!

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

@CanIgnoreReturnValue
fun setPlayerError(playerError: PlaybackException?): SimpleBasePlayer.State.Builder!

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
fun setPlaylist(playlist: (Mutable)List<SimpleBasePlayer.MediaItemData!>!): SimpleBasePlayer.State.Builder!

Sets the playlist as a list of media items.

All items must have unique UIDs.

This call replaces any previous playlist set via setPlaylist.

@CanIgnoreReturnValue
fun setPlaylist(
    timeline: Timeline!,
    currentTracks: Tracks!,
    currentMetadata: MediaMetadata?
): SimpleBasePlayer.State.Builder!

Sets the playlist as a Timeline with information about the current Tracks and MediaMetadata.

This call replaces any previous playlist set via setPlaylist.

@CanIgnoreReturnValue
fun setPlaylistMetadata(playlistMetadata: MediaMetadata!): SimpleBasePlayer.State.Builder!

Sets the playlist MediaMetadata.

@CanIgnoreReturnValue
fun setPositionDiscontinuity(
    @Player.DiscontinuityReason positionDiscontinuityReason: Int,
    discontinuityPositionMs: Long
): SimpleBasePlayer.State.Builder!

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

@CanIgnoreReturnValue
fun setRepeatMode(@Player.RepeatMode repeatMode: Int): SimpleBasePlayer.State.Builder!

Sets the RepeatMode used for playback.

@CanIgnoreReturnValue
fun setSeekBackIncrementMs(seekBackIncrementMs: Long): SimpleBasePlayer.State.Builder!

Sets the seekBack increment in milliseconds.

@CanIgnoreReturnValue
fun setSeekForwardIncrementMs(seekForwardIncrementMs: Long): SimpleBasePlayer.State.Builder!

Sets the seekForward increment in milliseconds.

@CanIgnoreReturnValue
fun setShuffleModeEnabled(shuffleModeEnabled: Boolean): SimpleBasePlayer.State.Builder!

Sets whether shuffling of media items is enabled.

@CanIgnoreReturnValue
fun setSurfaceSize(surfaceSize: Size!): SimpleBasePlayer.State.Builder!

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

@CanIgnoreReturnValue
fun setTimedMetadata(timedMetadata: Metadata!): SimpleBasePlayer.State.Builder!

Sets the most recent timed Metadata.

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

@CanIgnoreReturnValue
fun setTotalBufferedDurationMs(
    totalBufferedDurationMsSupplier: SimpleBasePlayer.PositionSupplier!
): SimpleBasePlayer.State.Builder!

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

@CanIgnoreReturnValue
fun setTrackSelectionParameters(
    trackSelectionParameters: TrackSelectionParameters!
): SimpleBasePlayer.State.Builder!

Sets the currently active TrackSelectionParameters.

@CanIgnoreReturnValue
fun setVideoSize(videoSize: VideoSize!): SimpleBasePlayer.State.Builder!

Sets the current video size.

@CanIgnoreReturnValue
fun setVolume(volume: @FloatRange(from = 0, to = 1.0) Float): SimpleBasePlayer.State.Builder!

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