SimpleBasePlayer


@UnstableApi
public abstract class SimpleBasePlayer extends BasePlayer

Known direct subclasses
ForwardingSimpleBasePlayer

A SimpleBasePlayer that forwards all calls to another Player instance.


A base implementation for Player that reduces the number of methods to implement to a minimum.

Implementation notes:

  • Subclasses must override getState to populate the current player state on request.
  • The State should set the available commands to indicate which Player methods are supported.
  • All setter-like player methods (for example, setPlayWhenReady) forward to overridable methods (for example, handleSetPlayWhenReady) that can be used to handle these requests. These methods return a ListenableFuture to indicate when the request has been handled and is fully reflected in the values returned from getState. This class will automatically request a state update once the request is done. If the state changes can be handled synchronously, these methods can return Guava's immediateVoidFuture.
  • Subclasses can manually trigger state updates with invalidateState, for example if something changes independent of Player method calls.
This base class handles various aspects of the player implementation to simplify the subclass:
  • The State can only be created with allowed combinations of state values, avoiding any invalid player states.
  • Only functionality that is declared as available needs to be implemented. Other methods are automatically ignored.
  • Listener handling and informing listeners of state changes is handled automatically.
  • The base class provides a framework for asynchronous handling of method calls. It changes the visible playback state immediately to the most likely outcome to ensure the user-visible state changes look like synchronous operations. The state is then updated again once the asynchronous method calls have been fully handled.

Summary

Nested types

A PositionSupplier connected to a live provider that returns a new value on each invocation until it is disconnected from the live source.

protected final class SimpleBasePlayer.MediaItemData

An immutable description of an item in the playlist, containing both static setup information like MediaItem and dynamic data that is generally read from the media like the duration.

A builder for MediaItemData objects.

protected final class SimpleBasePlayer.PeriodData

Data describing the properties of a period inside a MediaItemData.

A builder for PeriodData objects.

A supplier for a position.

public final class SimpleBasePlayer.State

An immutable state description of the player.

A builder for State objects.

Public fields

final Looper

Protected constructors

SimpleBasePlayer(Looper applicationLooper)

Creates the base class.

SimpleBasePlayer(Looper applicationLooper, Clock clock)

Creates the base class.

Public methods

final void

Registers a listener to receive all events from the player.

final void
addMediaItems(int index, List<MediaItem> mediaItems)

Adds a list of media items at the given index of the playlist.

final void

Clears any Surface, SurfaceHolder, SurfaceView or TextureView currently set on the player.

final void

Clears the Surface onto which video is being rendered if it matches the one passed.

final void

Clears the SurfaceHolder that holds the Surface onto which video is being rendered if it matches the one passed.

final void

Clears the SurfaceView onto which video is being rendered if it matches the one passed.

final void

Clears the TextureView onto which video is being rendered if it matches the one passed.

final void

This method is deprecated.

Use decreaseDeviceVolume instead.

final void

Decreases the volume of the device.

final Looper

Returns the Looper associated with the application thread that's used to access the player and on which player events are received.

final AudioAttributes

Returns the attributes for audio playback.

final Player.Commands

Returns the player's currently available Commands.

final long

Returns an estimate of the position in the current content or ad up to which data is buffered, in milliseconds.

final long

If isPlayingAd returns true, returns an estimate of the content position in the current content up to which data is buffered, in milliseconds.

final long

If isPlayingAd returns true, returns the content position that will be played once all ads in the ad group have finished playing, in milliseconds.

final int

If isPlayingAd returns true, returns the index of the ad group in the period currently being played.

final int

If isPlayingAd returns true, returns the index of the ad in its ad group.

final CueGroup

Returns the current CueGroup.

final int

Returns the index of the current MediaItem in the timeline, or the prospective index if the current timeline is empty.

final int

Returns the index of the period currently being played.

final long

Returns the playback position in the current content or ad, in milliseconds, or the prospective position in milliseconds if the current timeline is empty.

final Timeline

Returns the current Timeline.

final Tracks

Returns the current tracks.

final DeviceInfo

Gets the device information.

final int

Gets the current volume of the device.

final long

Returns the duration of the current content or ad in milliseconds, or TIME_UNSET if the duration is not known.

final long

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

final MediaMetadata

Returns the current combined MediaMetadata, or EMPTY if not supported.

final boolean

Whether playback will proceed when getPlaybackState == STATE_READY.

final PlaybackParameters

Returns the currently active playback parameters.

final int

Returns the current playback state of the player.

final int

Returns the reason why playback is suppressed even though getPlayWhenReady is true, or PLAYBACK_SUPPRESSION_REASON_NONE if playback is not suppressed.

final @Nullable PlaybackException

Returns the error that caused playback to fail.

final MediaMetadata

Returns the playlist MediaMetadata, as set by setPlaylistMetadata, or EMPTY if not supported.

final int

Returns the current RepeatMode used for playback.

final long

Returns the seekBack increment.

final long

Returns the seekForward increment.

final boolean

Returns whether shuffling of media items is enabled.

final Size

Gets the size of the surface on which the video is rendered.

final long

Returns an estimate of the total buffered duration from the current position, in milliseconds.

final TrackSelectionParameters

Returns the parameters constraining the track selection.

final VideoSize

Gets the size of the video.

final float

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

final void

This method is deprecated.

Use increaseDeviceVolume instead.

final void

Increases the volume of the device.

final boolean

Gets whether the device is muted or not.

final boolean

Whether the player is currently loading the source.

final boolean

Returns whether the player is currently playing an ad.

final void
moveMediaItems(int fromIndex, int toIndex, int newIndex)

Moves the media item range to the new index.

final void

Prepares the player.

final void

Releases the player.

final void

Unregister a listener registered through addListener.

final void
removeMediaItems(int fromIndex, int toIndex)

Removes a range of media items from the playlist.

final void
replaceMediaItems(
    int fromIndex,
    int toIndex,
    List<MediaItem> mediaItems
)

Replaces the media items at the given range of the playlist.

final void
setAudioAttributes(
    AudioAttributes audioAttributes,
    boolean handleAudioFocus
)

Sets the attributes for audio playback, used by the underlying audio track.

final void
setDeviceMuted(boolean muted)

This method is deprecated.

Use setDeviceMuted instead.

final void
setDeviceMuted(boolean muted, @C.VolumeFlags int flags)

Sets the mute state of the device.

final void
setDeviceVolume(int volume)

This method is deprecated.

Use setDeviceVolume instead.

final void
setDeviceVolume(int volume, @C.VolumeFlags int flags)

Sets the volume of the device with volume flags.

final void
setMediaItems(List<MediaItem> mediaItems, boolean resetPosition)

Clears the playlist and adds the specified media items.

final void
setMediaItems(
    List<MediaItem> mediaItems,
    int startIndex,
    long startPositionMs
)

Clears the playlist and adds the specified media items.

final void
setPlayWhenReady(boolean playWhenReady)

Sets whether playback should proceed when getPlaybackState == STATE_READY.

final void

Attempts to set the playback parameters.

final void

Sets the playlist MediaMetadata.

final void

Sets the RepeatMode to be used for playback.

final void
setShuffleModeEnabled(boolean shuffleModeEnabled)

Sets whether shuffling of media items is enabled.

final void

Sets the parameters constraining the track selection.

final void

Sets the Surface onto which video will be rendered.

final void

Sets the SurfaceHolder that holds the Surface onto which video will be rendered.

final void

Sets the SurfaceView onto which video will be rendered.

final void

Sets the TextureView onto which video will be rendered.

final void
setVolume(float volume)

Sets the audio volume, valid values are between 0 (silence) and 1 (unity gain, signal unchanged), inclusive.

final void

Stops playback without resetting the playlist.

Protected methods

SimpleBasePlayer.MediaItemData

Returns the placeholder MediaItemData used for a new MediaItem added to the playlist.

SimpleBasePlayer.State

Returns the placeholder state used while a player method is handled asynchronously.

abstract SimpleBasePlayer.State

Returns the current State of the player.

ListenableFuture<Object>
@ForOverride
handleAddMediaItems(int index, List<MediaItem> mediaItems)

Handles calls to addMediaItem and addMediaItems.

ListenableFuture<Object>

Handles calls to clear the video output.

ListenableFuture<Object>

Handles calls to decreaseDeviceVolume and decreaseDeviceVolume.

ListenableFuture<Object>

Handles calls to increaseDeviceVolume and increaseDeviceVolume.

ListenableFuture<Object>
@ForOverride
handleMoveMediaItems(int fromIndex, int toIndex, int newIndex)

Handles calls to moveMediaItem and moveMediaItems.

ListenableFuture<Object>

Handles calls to prepare.

ListenableFuture<Object>

Handles calls to release.

ListenableFuture<Object>
@ForOverride
handleRemoveMediaItems(int fromIndex, int toIndex)

Handles calls to removeMediaItem and removeMediaItems.

ListenableFuture<Object>
@ForOverride
handleReplaceMediaItems(
    int fromIndex,
    int toIndex,
    List<MediaItem> mediaItems
)

Handles calls to replaceMediaItem and replaceMediaItems.

ListenableFuture<Object>
@ForOverride
handleSeek(
    int mediaItemIndex,
    long positionMs,
    @Player.Command int seekCommand
)

Handles calls to seekTo and other seek operations (for example, seekToNext).

ListenableFuture<Object>
@ForOverride
handleSetAudioAttributes(
    AudioAttributes audioAttributes,
    boolean handleAudioFocus
)

Handles calls to set the audio attributes.

ListenableFuture<Object>
@ForOverride
handleSetDeviceMuted(boolean muted, @C.VolumeFlags int flags)

Handles calls to setDeviceMuted and setDeviceMuted.

ListenableFuture<Object>
@ForOverride
handleSetDeviceVolume(@IntRange(from = 0) int deviceVolume, int flags)

Handles calls to setDeviceVolume and setDeviceVolume.

ListenableFuture<Object>
@ForOverride
handleSetMediaItems(
    List<MediaItem> mediaItems,
    int startIndex,
    long startPositionMs
)

Handles calls to setMediaItem and setMediaItems.

ListenableFuture<Object>
@ForOverride
handleSetPlayWhenReady(boolean playWhenReady)

Handles calls to setPlayWhenReady, play and pause.

ListenableFuture<Object>

Handles calls to setPlaybackParameters or setPlaybackSpeed.

ListenableFuture<Object>

Handles calls to setPlaylistMetadata.

ListenableFuture<Object>

Handles calls to setRepeatMode.

ListenableFuture<Object>
@ForOverride
handleSetShuffleModeEnabled(boolean shuffleModeEnabled)

Handles calls to setShuffleModeEnabled.

ListenableFuture<Object>

Handles calls to setTrackSelectionParameters.

ListenableFuture<Object>

Handles calls to set the video output.

ListenableFuture<Object>
@ForOverride
handleSetVolume(@FloatRange(from = 0, to = 1.0) float volume)

Handles calls to setVolume.

ListenableFuture<Object>

Handles calls to stop.

final void

Invalidates the current state.

final void
seekTo(
    int mediaItemIndex,
    long positionMs,
    @Player.Command int seekCommand,
    boolean isRepeatingCurrentItem
)

Seeks to a position in the specified MediaItem.

final void

Throws an IllegalStateException if the the thread calling this method does not match the Looper thread that was specified upon construction of this instance.

Inherited Constants

From androidx.media3.common.Player
static final int

This field is deprecated.

Use COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS instead.

static final int

Command to increase and decrease the device volume and mute it with volume flags.

static final int

Command to change the media items in the playlist.

static final int

Command to get the player current AudioAttributes.

static final int

Command to get information about the currently playing MediaItem.

static final int

Command to get the device volume and whether it is muted.

static final int

This field is deprecated.

Use COMMAND_GET_METADATA instead.

static final int

Command to get metadata related to the playlist and current MediaItem.

static final int

Command to get the text that should currently be displayed by the player.

static final int

Command to get the information about the current timeline.

static final int

Command to get details of the current track selection.

static final int

Command to get the player volume.

static final int

Represents an invalid Command.

static final int

Command to start, pause or resume playback.

static final int

Command to prepare the player.

static final int

Command to release the player.

static final int

Command to seek back by a fixed increment inside the current MediaItem.

static final int

Command to seek forward by a fixed increment inside the current MediaItem.

static final int

Command to seek anywhere inside the current MediaItem.

static final int

This field is deprecated.

Use COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM instead.

static final int

Command to seek to the default position of the current MediaItem.

static final int

Command to seek anywhere in any MediaItem.

static final int

Command to seek to a later position in the current MediaItem or the default position of the next MediaItem.

static final int

Command to seek to the default position of the next MediaItem.

static final int

This field is deprecated.

Use COMMAND_SEEK_TO_NEXT_MEDIA_ITEM instead.

static final int

Command to seek to an earlier position in the current MediaItem or the default position of the previous MediaItem.

static final int

Command to seek to the default position of the previous MediaItem.

static final int

This field is deprecated.

Use COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM instead.

static final int

This field is deprecated.

Use COMMAND_SEEK_TO_MEDIA_ITEM instead.

static final int

Command to set the player's audio attributes.

static final int

This field is deprecated.

Use COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS instead.

static final int

Command to set the device volume with volume flags.

static final int

Command to set a MediaItem.

static final int

This field is deprecated.

Use COMMAND_SET_PLAYLIST_METADATA instead.

static final int

Command to set the playlist metadata.

static final int

Command to set the repeat mode.

static final int

Command to enable shuffling.

static final int

Command to set the playback speed and pitch.

static final int

Command to set the player's track selection parameters.

static final int

Command to set and clear the surface on which to render the video.

static final int

Command to set the player volume.

static final int

Command to stop playback.

static final int

Automatic playback transition from one period in the timeline to the next.

static final int

Discontinuity introduced internally (e.g. by the source).

static final int

Discontinuity caused by the removal of the current period from the Timeline.

static final int

Seek within the current period or to another period.

static final int

Seek adjustment due to being unable to seek to the requested position or because the seek was permitted to be inexact.

static final int

Discontinuity introduced by a skipped silence.

static final int

Discontinuity introduced by a skipped period (for instance a skipped ad).

static final int

getAudioAttributes changed.

static final int

The audio session id was set.

static final int

isCommandAvailable changed for at least one Command.

static final int

getCurrentCues changed.

static final int

getDeviceInfo changed.

static final int

getDeviceVolume changed.

static final int

isLoading ()} changed.

static final int

isPlaying changed.

static final int

getMaxSeekToPreviousPosition changed.

static final int

getCurrentMediaItem changed or the player started repeating the current item.

static final int

getMediaMetadata changed.

static final int

Metadata associated with the current playback time changed.

static final int

getPlaybackParameters changed.

static final int

getPlaybackState changed.

static final int

getPlaybackSuppressionReason changed.

static final int

getPlayerError changed.

static final int

getPlaylistMetadata changed.

static final int

getPlayWhenReady changed.

static final int

A position discontinuity occurred.

static final int

A frame is rendered for the first time since setting the surface, or since the renderer was reset, or since the stream being rendered was changed.

static final int

getRepeatMode changed.

static final int

getSeekBackIncrement changed.

static final int

getSeekForwardIncrement changed.

static final int

getShuffleModeEnabled changed.

static final int

Skipping silences in the audio stream is enabled or disabled.

static final int

The size of the surface onto which the video is being rendered changed.

static final int

getCurrentTimeline changed.

static final int

getCurrentTracks changed.

static final int

getTrackSelectionParameters changed.

static final int

getVideoSize changed.

static final int

getVolume changed.

static final int

Playback has automatically transitioned to the next media item.

static final int

The current media item has changed because of a change in the playlist.

static final int

The media item has been repeated.

static final int

A seek to another media item has occurred.

static final int

Playback is not suppressed.

static final int

Playback is suppressed due to transient audio focus loss.

static final int

Playback is suppressed due to attempt to play on an unsuitable audio output (e.g. attempt to play on built-in speaker on a Wear OS device).

static final int

This field is deprecated.

Use PLAYBACK_SUPPRESSION_REASON_UNSUITABLE_AUDIO_OUTPUT instead.

static final int

Playback has been paused to avoid becoming noisy.

static final int

Playback has been paused because of a loss of audio focus.

static final int

Playback has been paused at the end of a media item.

static final int

Playback has been started or paused because of a remote change.

static final int

Playback has been paused because playback has been suppressed too long.

static final int

Playback has been started or paused by a call to setPlayWhenReady.

static final int

Repeats the entire timeline infinitely.

static final int

Normal playback without repetition.

static final int

Repeats the currently playing MediaItem infinitely during ongoing playback.

static final int

The player is not able to immediately play the media, but is doing work toward being able to do so.

static final int

The player has finished playing the media.

static final int

The player is idle, meaning it holds only limited resources.

static final int

The player is able to immediately play from its current position.

static final int

Timeline changed as a result of a change of the playlist items or the order of the items.

static final int

Timeline changed as a result of a source update (e.g. result of a dynamic update by the played media).

Inherited methods

From androidx.media3.common.BasePlayer
final void

Adds a media item to the end of the playlist.

final void
addMediaItem(int index, MediaItem mediaItem)

Adds a media item at the given index of the playlist.

final void