BasePlayer

Kotlin |Java

@UnstableApi
public abstract class BasePlayer implements Player

Known direct subclasses

RemoteCastPlayer, SimpleBasePlayer, SimpleExoPlayer, StubPlayer

`RemoteCastPlayer`	`Player` implementation that communicates with a Cast receiver app.
`SimpleBasePlayer`	A base implementation for `Player` that reduces the number of methods to implement to a minimum.
`SimpleExoPlayer`	This class is deprecated. Use `ExoPlayer` instead.
`StubPlayer`	An abstract `Player` implementation that throws `UnsupportedOperationException` from every method.

Known indirect subclasses

CompositionPlayer, FakePlayer, ForwardingSimpleBasePlayer, StubExoPlayer

`CompositionPlayer`	A `Player` implementation that plays `compositions` of media assets.
`FakePlayer`	A fake `Player` that uses `SimpleBasePlayer`'s minimal number of default methods implementations to build upon to simulate realistic playback scenarios for testing.
`ForwardingSimpleBasePlayer`	A `SimpleBasePlayer` that forwards all calls to another `Player` instance.
`StubExoPlayer`	An abstract `ExoPlayer` implementation that throws `UnsupportedOperationException` from every method.

Abstract base Player which implements common implementation independent methods.

Summary

Protected fields
`final Timeline.Window`	`window`

Protected constructors
`BasePlayer()`

Public methods
`final void`	`addMediaItem(MediaItem mediaItem)` 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`	`addMediaItems(List<MediaItem> mediaItems)` Adds a list of media items to the end of the playlist.
`final boolean`	`canAdvertiseSession()` Returns whether the player can be used to advertise a media session.
`final void`	`clearMediaItems()` Clears the playlist.
`final int`	`getBufferedPercentage()` Returns an estimate of the percentage in the current content or ad up to which data is buffered, or 0 if no estimate is available.
`final long`	`getContentDuration()` If `isPlayingAd` returns `true`, returns the duration of the current content in milliseconds, or `TIME_UNSET` if the duration is not known.
`final long`	`getCurrentLiveOffset()` Returns the offset of the current playback position from the live edge in milliseconds, or `TIME_UNSET` if the current `MediaItemisn't live` or the offset is unknown.
`final @Nullable Object`	`getCurrentManifest()` Returns the current manifest.
`final @Nullable MediaItem`	`getCurrentMediaItem()` Returns the currently playing `MediaItem`.
`final int`	`getCurrentWindowIndex()` This method is deprecated. Use `getCurrentMediaItemIndex` instead.
`final MediaItem`	`getMediaItemAt(int index)` Returns the `MediaItem` at the given index.
`final int`	`getMediaItemCount()` Returns the number of `media items` in the playlist.
`final int`	`getNextMediaItemIndex()` Returns the index of the `MediaItem` that will be played if `seekToNextMediaItem` is called, which may depend on the current repeat mode and whether shuffle mode is enabled.
`final int`	`getNextWindowIndex()` This method is deprecated. Use `getNextMediaItemIndex` instead.
`final int`	`getPreviousMediaItemIndex()` Returns the index of the `MediaItem` that will be played if `seekToPreviousMediaItem` is called, which may depend on the current repeat mode and whether shuffle mode is enabled.
`final int`	`getPreviousWindowIndex()` This method is deprecated. Use `getPreviousMediaItemIndex` instead.
`final boolean`	`hasNextMediaItem()` Returns whether a next `MediaItem` exists, which may depend on the current repeat mode and whether shuffle mode is enabled.
`final boolean`	`hasPreviousMediaItem()` Returns whether a previous media item exists, which may depend on the current repeat mode and whether shuffle mode is enabled.
`final boolean`	`isCommandAvailable(@Player.Command int command)` Returns whether the provided `Command` is available.
`final boolean`	`isCurrentMediaItemDynamic()` Returns whether the current `MediaItem` is dynamic (may change when the `Timeline` is updated), or `false` if the `Timeline` is empty.
`final boolean`	`isCurrentMediaItemLive()` Returns whether the current `MediaItem` is live, or `false` if the `Timeline` is empty.
`final boolean`	`isCurrentMediaItemSeekable()` Returns whether the current `MediaItem` is seekable, or `false` if the `Timeline` is empty.
`final boolean`	`isCurrentWindowDynamic()` This method is deprecated. Use `isCurrentMediaItemDynamic` instead.
`final boolean`	`isCurrentWindowLive()` This method is deprecated. Use `isCurrentMediaItemLive` instead.
`final boolean`	`isCurrentWindowSeekable()` This method is deprecated. Use `isCurrentMediaItemSeekable` instead.
`final boolean`	`isPlaying()` Returns whether the player is playing, i.e. `getCurrentPosition` is advancing.
`final void`	`moveMediaItem(int currentIndex, int newIndex)` Moves the media item at the current index to the new index.
`final void`	`pause()` Pauses playback.
`final void`	`play()` Resumes playback as soon as `getPlaybackState` == `STATE_READY`.
`final void`	`removeMediaItem(int index)` Removes the media item at the given index of the playlist.
`final void`	`replaceMediaItem(int index, MediaItem mediaItem)` Replaces the media item at the given index of the playlist.
`final void`	`seekBack()` Seeks back in the current `MediaItem` by `getSeekBackIncrement` milliseconds.
`final void`	`seekForward()` Seeks forward in the current `MediaItem` by `getSeekForwardIncrement` milliseconds.
`final void`	`seekTo(long positionMs)` Seeks to a position specified in milliseconds in the current `MediaItem`.
`final void`	`seekTo(int mediaItemIndex, long positionMs)` Seeks to a position specified in milliseconds in the specified `MediaItem`.
`final void`	`seekToDefaultPosition()` Seeks to the default position associated with the current `MediaItem`.
`final void`	`seekToDefaultPosition(int mediaItemIndex)` Seeks to the default position associated with the specified `MediaItem`.
`final void`	`seekToNext()` Seeks to a later position in the current or next `MediaItem` (if available).
`final void`	`seekToNextMediaItem()` Seeks to the default position of the next `MediaItem`, which may depend on the current repeat mode and whether shuffle mode is enabled.
`final void`	`seekToPrevious()` Seeks to an earlier position in the current or previous `MediaItem` (if available).
`final void`	`seekToPreviousMediaItem()` Seeks to the default position of the previous `MediaItem`, which may depend on the current repeat mode and whether shuffle mode is enabled.
`final void`	`setMediaItem(MediaItem mediaItem)` Clears the playlist, adds the specified `MediaItem` and resets the position to the default position.
`final void`	`setMediaItem(MediaItem mediaItem, boolean resetPosition)` Clears the playlist and adds the specified `MediaItem`.
`final void`	`setMediaItem(MediaItem mediaItem, long startPositionMs)` Clears the playlist and adds the specified `MediaItem`.
`final void`	`setMediaItems(List<MediaItem> mediaItems)` Clears the playlist, adds the specified `media items` and resets the position to the default position.
`final void`	`setPlaybackSpeed(float speed)` Changes the rate at which playback occurs.

Protected methods
`abstract void`	`@ForOverride seekTo( int mediaItemIndex, long positionMs, @Player.Command int seekCommand, boolean isRepeatingCurrentItem )` Seeks to a position in the specified `MediaItem`.

Inherited Constants

From androidx.media3.common.Player

`static final int`	`COMMAND_ADJUST_DEVICE_VOLUME = 26` This field is deprecated. Use `COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS` instead.
`static final int`	`COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS = 34` Command to increase and decrease the device volume and mute it with volume flags.
`static final int`	`COMMAND_CHANGE_MEDIA_ITEMS = 20` Command to change the `media items` in the playlist.
`static final int`	`COMMAND_GET_AUDIO_ATTRIBUTES = 21` Command to get the player current `AudioAttributes`.
`static final int`	`COMMAND_GET_CURRENT_MEDIA_ITEM = 16` Command to get information about the currently playing `MediaItem`.
`static final int`	`COMMAND_GET_DEVICE_VOLUME = 23` Command to get the device volume and whether it is muted.
`static final int`	`COMMAND_GET_MEDIA_ITEMS_METADATA = 18` This field is deprecated. Use `COMMAND_GET_METADATA` instead.
`static final int`	`COMMAND_GET_METADATA = 18` Command to get metadata related to the playlist and current `MediaItem`.
`static final int`	`COMMAND_GET_TEXT = 28` Command to get the text that should currently be displayed by the player.
`static final int`	`COMMAND_GET_TIMELINE = 17` Command to get the information about the current timeline.
`static final int`	`COMMAND_GET_TRACKS = 30` Command to get details of the current track selection.
`static final int`	`COMMAND_GET_VOLUME = 22` Command to get the player volume.
`static final int`	`COMMAND_INVALID = -1` Represents an invalid `Command`.
`static final int`	`COMMAND_PLAY_PAUSE = 1` Command to start, pause or resume playback.
`static final int`	`COMMAND_PREPARE = 2` Command to prepare the player.
`static final int`	`COMMAND_RELEASE = 32` Command to release the player.
`static final int`	`COMMAND_SEEK_BACK = 11` Command to seek back by a fixed increment inside the current `MediaItem`.
`static final int`	`COMMAND_SEEK_FORWARD = 12` Command to seek forward by a fixed increment inside the current `MediaItem`.
`static final int`	`COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM = 5` Command to seek anywhere inside the current `MediaItem`.
`static final int`	`@UnstableApi COMMAND_SEEK_IN_CURRENT_WINDOW = 5` This field is deprecated. Use `COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM` instead.
`static final int`	`COMMAND_SEEK_TO_DEFAULT_POSITION = 4` Command to seek to the default position of the current `MediaItem`.
`static final int`	`COMMAND_SEEK_TO_MEDIA_ITEM = 10` Command to seek anywhere in any `MediaItem`.
`static final int`	`COMMAND_SEEK_TO_NEXT = 9` Command to seek to a later position in the current `MediaItem` or the default position of the next `MediaItem`.
`static final int`	`COMMAND_SEEK_TO_NEXT_MEDIA_ITEM = 8` Command to seek to the default position of the next `MediaItem`.
`static final int`	`@UnstableApi COMMAND_SEEK_TO_NEXT_WINDOW = 8` This field is deprecated. Use `COMMAND_SEEK_TO_NEXT_MEDIA_ITEM` instead.
`static final int`	`COMMAND_SEEK_TO_PREVIOUS = 7` Command to seek to an earlier position in the current `MediaItem` or the default position of the previous `MediaItem`.
`static final int`	`COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM = 6` Command to seek to the default position of the previous `MediaItem`.
`static final int`	`@UnstableApi COMMAND_SEEK_TO_PREVIOUS_WINDOW = 6` This field is deprecated. Use `COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM` instead.
`static final int`	`@UnstableApi COMMAND_SEEK_TO_WINDOW = 10` This field is deprecated. Use `COMMAND_SEEK_TO_MEDIA_ITEM` instead.
`static final int`	`COMMAND_SET_AUDIO_ATTRIBUTES = 35` Command to set the player's audio attributes.
`static final int`	`COMMAND_SET_DEVICE_VOLUME = 25` This field is deprecated. Use `COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS` instead.
`static final int`	`COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS = 33` Command to set the device volume with volume flags.
`static final int`	`COMMAND_SET_MEDIA_ITEM = 31` Command to set a `MediaItem`.
`static final int`	`COMMAND_SET_MEDIA_ITEMS_METADATA = 19` This field is deprecated. Use `COMMAND_SET_PLAYLIST_METADATA` instead.
`static final int`	`COMMAND_SET_PLAYLIST_METADATA = 19` Command to set the playlist metadata.
`static final int`	`COMMAND_SET_REPEAT_MODE = 15` Command to set the repeat mode.
`static final int`	`COMMAND_SET_SHUFFLE_MODE = 14` Command to enable shuffling.
`static final int`	`COMMAND_SET_SPEED_AND_PITCH = 13` Command to set the playback speed and pitch.
`static final int`	`COMMAND_SET_TRACK_SELECTION_PARAMETERS = 29` Command to set the player's track selection parameters.
`static final int`	`COMMAND_SET_VIDEO_SURFACE = 27` Command to set and clear the surface on which to render the video.
`static final int`	`COMMAND_SET_VOLUME = 24` Command to set the player volume.
`static final int`	`COMMAND_STOP = 3` Command to stop playback.
`static final int`	`DISCONTINUITY_REASON_AUTO_TRANSITION = 0` Automatic playback transition from one period in the timeline to the next.
`static final int`	`DISCONTINUITY_REASON_INTERNAL = 5` Discontinuity introduced internally (e.g. by the source).
`static final int`	`DISCONTINUITY_REASON_REMOVE = 4` Discontinuity caused by the removal of the current period from the `Timeline`.
`static final int`	`DISCONTINUITY_REASON_SEEK = 1` Seek within the current period or to another period.
`static final int`	`DISCONTINUITY_REASON_SEEK_ADJUSTMENT = 2` 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_REASON_SILENCE_SKIP = 6` Discontinuity introduced by a skipped silence.
`static final int`	`DISCONTINUITY_REASON_SKIP = 3` Discontinuity introduced by a skipped period (for instance a skipped ad).
`static final int`	`EVENT_AUDIO_ATTRIBUTES_CHANGED = 20` `getAudioAttributes` changed.
`static final int`	`EVENT_AUDIO_SESSION_ID = 21` The audio session id was set.
`static final int`	`EVENT_AVAILABLE_COMMANDS_CHANGED = 13` `isCommandAvailable` changed for at least one `Command`.
`static final int`	`EVENT_CUES = 27` `getCurrentCues` changed.
`static final int`	`EVENT_DEVICE_INFO_CHANGED = 29` `getDeviceInfo` changed.
`static final int`	`EVENT_DEVICE_VOLUME_CHANGED = 30` `getDeviceVolume` or `isDeviceMuted` changed.
`static final int`	`EVENT_IS_LOADING_CHANGED = 3` `isLoading` ()} changed.
`static final int`	`EVENT_IS_PLAYING_CHANGED = 7` `isPlaying` changed.
`static final int`	`EVENT_MAX_SEEK_TO_PREVIOUS_POSITION_CHANGED = 18` `getMaxSeekToPreviousPosition` changed.
`static final int`	`EVENT_MEDIA_ITEM_TRANSITION = 1` `getCurrentMediaItem` changed or the player started repeating the current item.
`static final int`	`EVENT_MEDIA_METADATA_CHANGED = 14` `getMediaMetadata` changed.
`static final int`	`EVENT_METADATA = 28` Metadata associated with the current playback time changed.
`static final int`	`EVENT_PLAYBACK_PARAMETERS_CHANGED = 12` `getPlaybackParameters` changed.
`static final int`	`EVENT_PLAYBACK_STATE_CHANGED = 4` `getPlaybackState` changed.
`static final int`	`EVENT_PLAYBACK_SUPPRESSION_REASON_CHANGED = 6` `getPlaybackSuppressionReason` changed.
`static final int`	`EVENT_PLAYER_ERROR = 10` `getPlayerError` changed.
`static final int`	`EVENT_PLAYLIST_METADATA_CHANGED = 15` `getPlaylistMetadata` changed.
`static final int`	`EVENT_PLAY_WHEN_READY_CHANGED = 5` `getPlayWhenReady` changed.
`static final int`	`EVENT_POSITION_DISCONTINUITY = 11` A position discontinuity occurred.
`static final int`	`EVENT_RENDERED_FIRST_FRAME = 26` 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`	`EVENT_REPEAT_MODE_CHANGED = 8` `getRepeatMode` changed.
`static final int`	`EVENT_SEEK_BACK_INCREMENT_CHANGED = 16` `getSeekBackIncrement` changed.
`static final int`	`EVENT_SEEK_FORWARD_INCREMENT_CHANGED = 17` `getSeekForwardIncrement` changed.
`static final int`	`EVENT_SHUFFLE_MODE_ENABLED_CHANGED = 9` `getShuffleModeEnabled` changed.
`static final int`	`EVENT_SKIP_SILENCE_ENABLED_CHANGED = 23` Skipping silences in the audio stream is enabled or disabled.
`static final int`	`EVENT_SURFACE_SIZE_CHANGED = 24` The size of the surface onto which the video is being rendered changed.
`static final int`	`EVENT_TIMELINE_CHANGED = 0` `getCurrentTimeline` changed.
`static final int`	`EVENT_TRACKS_CHANGED = 2` `getCurrentTracks` changed.
`static final int`	`EVENT_TRACK_SELECTION_PARAMETERS_CHANGED = 19` `getTrackSelectionParameters` changed.
`static final int`	`EVENT_VIDEO_SIZE_CHANGED = 25` `getVideoSize` changed.
`static final int`	`EVENT_VOLUME_CHANGED = 22` `getVolume` changed.
`static final int`	`MEDIA_ITEM_TRANSITION_REASON_AUTO = 1` Playback has automatically transitioned to the next media item.
`static final int`	`MEDIA_ITEM_TRANSITION_REASON_PLAYLIST_CHANGED = 3` The current media item has changed because of a change in the playlist.
`static final int`	`MEDIA_ITEM_TRANSITION_REASON_REPEAT = 0` The media item has been repeated.
`static final int`	`MEDIA_ITEM_TRANSITION_REASON_SEEK = 2` A seek to another media item has occurred.
`static final int`	`PLAYBACK_SUPPRESSION_REASON_NONE = 0` Playback is not suppressed.
`static final int`	`PLAYBACK_SUPPRESSION_REASON_SCRUBBING = 4` Playback is suppressed because the player is currently scrubbing.
`static final int`	`PLAYBACK_SUPPRESSION_REASON_TRANSIENT_AUDIO_FOCUS_LOSS = 1` Playback is suppressed due to transient audio focus loss.
`static final int`	`PLAYBACK_SUPPRESSION_REASON_UNSUITABLE_AUDIO_OUTPUT = 3` 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`	`PLAYBACK_SUPPRESSION_REASON_UNSUITABLE_AUDIO_ROUTE = 2` This field is deprecated. Use `PLAYBACK_SUPPRESSION_REASON_UNSUITABLE_AUDIO_OUTPUT` instead.
`static final int`	`PLAY_WHEN_READY_CHANGE_REASON_AUDIO_BECOMING_NOISY = 3` Playback has been paused to avoid becoming noisy.
`static final int`	`PLAY_WHEN_READY_CHANGE_REASON_AUDIO_FOCUS_LOSS = 2` Playback has been paused because of a loss of audio focus.
`static final int`	`PLAY_WHEN_READY_CHANGE_REASON_END_OF_MEDIA_ITEM = 5` Playback has been paused at the end of a media item.
`static final int`	`PLAY_WHEN_READY_CHANGE_REASON_REMOTE = 4` Playback has been started or paused because of a remote change.
`static final int`	`PLAY_WHEN_READY_CHANGE_REASON_SUPPRESSED_TOO_LONG = 6` Playback has been paused because playback has been `suppressed` too long.
`static final int`	`PLAY_WHEN_READY_CHANGE_REASON_USER_REQUEST = 1` Playback has been started or paused by a call to `setPlayWhenReady`.
`static final int`	`REPEAT_MODE_ALL = 2` Repeats the entire timeline infinitely.
`static final int`	`REPEAT_MODE_OFF = 0` Normal playback without repetition.
`static final int`	`REPEAT_MODE_ONE = 1` Repeats the currently playing `MediaItem` infinitely during ongoing playback.
`static final int`	`STATE_BUFFERING = 2` The player is not able to immediately play the media, but is doing work toward being able to do so.
`static final int`	`STATE_ENDED = 4` The player has finished playing the media.
`static final int`	`STATE_IDLE = 1` The player is idle, meaning it holds only limited resources.
`static final int`	`STATE_READY = 3` The player is able to immediately play from its current position.
`static final int`	`TIMELINE_CHANGE_REASON_PLAYLIST_CHANGED = 0` Timeline changed as a result of a change of the playlist items or the order of the items.
`static final int`	`TIMELINE_CHANGE_REASON_SOURCE_UPDATE = 1` 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.Player

`abstract void`	`addListener(Player.Listener listener)` Registers a listener to receive all events from the player.
`abstract void`	`addMediaItems(int index, List<MediaItem> mediaItems)` Adds a list of media items at the given index of the playlist.
`abstract void`	`clearVideoSurface()` Clears any `Surface`, `SurfaceHolder`, `SurfaceView` or `TextureView` currently set on the player.
`abstract void`	`clearVideoSurface(@Nullable Surface surface)` Clears the `Surface` onto which video is being rendered if it matches the one passed.
`abstract void`	`clearVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)` Clears the `SurfaceHolder` that holds the `Surface` onto which video is being rendered if it matches the one passed.
`abstract void`	`clearVideoSurfaceView(@Nullable SurfaceView surfaceView)` Clears the `SurfaceView` onto which video is being rendered if it matches the one passed.
`abstract void`	`clearVideoTextureView(@Nullable TextureView textureView)` Clears the `TextureView` onto which video is being rendered if it matches the one passed.
`abstract void`	`decreaseDeviceVolume()` This method is deprecated. Use `decreaseDeviceVolume` instead.
`abstract void`	`decreaseDeviceVolume(@C.VolumeFlags int flags)` Decreases the volume of the device.
`abstract Looper`	`getApplicationLooper()` Returns the `Looper` associated with the application thread that's used to access the player and on which player events are received.
`abstract AudioAttributes`	`getAudioAttributes()` Returns the attributes for audio playback.
`int`	`@UnstableApi getAudioSessionId()` Returns the audio session identifier, or `AUDIO_SESSION_ID_UNSET` if not set.
`abstract Player.Commands`	`getAvailableCommands()` Returns the player's currently available `Commands`.
`abstract long`	`getBufferedPosition()` Returns an estimate of the position in the current content or ad up to which data is buffered, in milliseconds.
`abstract long`	`getContentBufferedPosition()` If `isPlayingAd` returns `true`, returns an estimate of the content position in the current content up to which data is buffered, in milliseconds.
`abstract long`	`getContentPosition()` If `isPlayingAd` returns `true`, returns the content position that will be played once all ads in the ad group have finished playing, in milliseconds.
`abstract int`	`getCurrentAdGroupIndex()` If `isPlayingAd` returns true, returns the index of the ad group in the period currently being played.
`abstract int`	`getCurrentAdIndexInAdGroup()` If `isPlayingAd` returns true, returns the index of the ad in its ad group.
`abstract CueGroup`	`getCurrentCues()` Returns the current `CueGroup`.
`abstract int`	`getCurrentMediaItemIndex()` Returns the index of the current `MediaItem` in the `timeline`, or the prospective index if the `current timeline` is empty.
`abstract int`	`getCurrentPeriodIndex()` Returns the index of the period currently being played.
`abstract long`	`getCurrentPosition()` Returns the playback position in the current content or ad, in milliseconds, or the prospective position in milliseconds if the `current timeline` is empty.
`abstract Timeline`	`getCurrentTimeline()` Returns the current `Timeline`.
`abstract Tracks`	`getCurrentTracks()` Returns the current tracks.
`abstract DeviceInfo`	`getDeviceInfo()` Gets the device information.
`abstract @IntRange(from = 0) int`	`getDeviceVolume()` Gets the current volume of the device.
`abstract long`	`getDuration()` Returns the duration of the current content or ad in milliseconds, or `TIME_UNSET` if the duration is not known.
`abstract long`	`getMaxSeekToPreviousPosition()` Returns the maximum position for which `seekToPrevious` seeks to the previous `MediaItem`, in milliseconds.
`abstract MediaMetadata`	`getMediaMetadata()` Returns the current combined `MediaMetadata`, or `EMPTY` if not supported.
`abstract boolean`	`getPlayWhenReady()` Whether playback will proceed when `getPlaybackState` == `STATE_READY`.
`abstract PlaybackParameters`	`getPlaybackParameters()` Returns the currently active playback parameters.
`abstract int`	`@Player.State getPlaybackState()` Returns the current `playback state` of the player.
`abstract int`	`@Player.PlaybackSuppressionReason getPlaybackSuppressionReason()` Returns the reason why playback is suppressed even though `getPlayWhenReady` is `true`, or `PLAYBACK_SUPPRESSION_REASON_NONE` if playback is not suppressed.
`abstract @Nullable PlaybackException`	`getPlayerError()` Returns the error that caused playback to fail.
`abstract MediaMetadata`	`getPlaylistMetadata()` Returns the playlist `MediaMetadata`, as set by `setPlaylistMetadata`, or `EMPTY` if not supported.
`abstract int`	`@Player.RepeatMode getRepeatMode()` Returns the current `RepeatMode` used for playback.
`abstract long`	`getSeekBackIncrement()` Returns the `seekBack` increment.
`abstract long`	`getSeekForwardIncrement()` Returns the `seekForward` increment.
`abstract boolean`	`getShuffleModeEnabled()` Returns whether shuffling of media items is enabled.
`abstract Size`	`@UnstableApi getSurfaceSize()` Gets the size of the surface on which the video is rendered.
`abstract long`	`getTotalBufferedDuration()` Returns an estimate of the total buffered duration from the current position, in milliseconds.
`abstract TrackSelectionParameters`	`getTrackSelectionParameters()` Returns the parameters constraining the track selection.
`abstract VideoSize`	`getVideoSize()` Gets the size of the video.
`abstract @FloatRange(from = 0, to = 1.0) float`	`getVolume()` Returns the audio volume, with 0 being silence and 1 being unity gain (signal unchanged).
`abstract void`	`increaseDeviceVolume()` This method is deprecated. Use `increaseDeviceVolume` instead.
`abstract void`	`increaseDeviceVolume(@C.VolumeFlags int flags)` Increases the volume of the device.
`abstract boolean`	`isDeviceMuted()` Gets whether the device is muted or not.
`abstract boolean`	`isLoading()` Whether the player is currently loading the source.
`abstract boolean`	`isPlayingAd()` Returns whether the player is currently playing an ad.
`abstract void`	`moveMediaItems(int fromIndex, int toIndex, int newIndex)` Moves the media item range to the new index.
`abstract void`	`@UnstableApi mute()` Sets the audio volume to 0.
`abstract void`	`prepare()` Prepares the player.
`abstract void`	`release()` Releases the player.
`abstract void`	`removeListener(Player.Listener listener)` Unregister a listener registered through `addListener`.
`abstract void`	`removeMediaItems(int fromIndex, int toIndex)` Removes a range of media items from the playlist.
`abstract void`	`replaceMediaItems( int fromIndex, int toIndex, List<MediaItem> mediaItems )` Replaces the media items at the given range of the playlist.
`abstract void`	`setAudioAttributes( AudioAttributes audioAttributes, boolean handleAudioFocus )` Sets the attributes for audio playback, used by the underlying audio track.
`abstract void`	`setDeviceMuted(boolean muted)` This method is deprecated. Use `setDeviceMuted` instead.
`abstract void`	`setDeviceMuted(boolean muted, @C.VolumeFlags int flags)` Sets the mute state of the device.
`abstract void`	`setDeviceVolume(@IntRange(from = 0) int volume)` This method is deprecated. Use `setDeviceVolume` instead.
`abstract void`	`setDeviceVolume(@IntRange(from = 0) int volume, @C.VolumeFlags int flags)` Sets the volume of the device with volume flags.
`abstract void`	`setMediaItems(List<MediaItem> mediaItems, boolean resetPosition)` Clears the playlist and adds the specified `media items`.
`abstract void`	`setMediaItems( List<MediaItem> mediaItems, int startIndex, long startPositionMs )` Clears the playlist and adds the specified `media items`.
`abstract void`	`setPlayWhenReady(boolean playWhenReady)` Sets whether playback should proceed when `getPlaybackState` == `STATE_READY`.
`abstract void`	`setPlaybackParameters(PlaybackParameters playbackParameters)` Attempts to set the playback parameters.
`abstract void`	`setPlaylistMetadata(MediaMetadata mediaMetadata)` Sets the playlist `MediaMetadata`.
`abstract void`	`setRepeatMode(@Player.RepeatMode int repeatMode)` Sets the `RepeatMode` to be used for playback.
`abstract void`	`setShuffleModeEnabled(boolean shuffleModeEnabled)` Sets whether shuffling of media items is enabled.
`abstract void`	`setTrackSelectionParameters(TrackSelectionParameters parameters)` Sets the parameters constraining the track selection.
`abstract void`	`setVideoSurface(@Nullable Surface surface)` Sets the `Surface` onto which video will be rendered.
`abstract void`	`setVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)` Sets the `SurfaceHolder` that holds the `Surface` onto which video will be rendered.
`abstract void`	`setVideoSurfaceView(@Nullable SurfaceView surfaceView)` Sets the `SurfaceView` onto which video will be rendered.
`abstract void`	`setVideoTextureView(@Nullable TextureView textureView)` Sets the `TextureView` onto which video will be rendered.
`abstract void`	`setVolume(@FloatRange(from = 0, to = 1.0) float volume)` Sets the audio volume, valid values are between 0 (silence) and 1 (unity gain, signal unchanged), inclusive.
`abstract void`	`stop()` Stops playback without resetting the playlist.
`abstract void`	`@UnstableApi unmute()` If the audio volume is 0, sets the audio volume to a non-zero value decided by the Player to be the most appropriate.

Protected fields

window

protected final Timeline.Window window

Protected constructors

BasePlayer

protected BasePlayer()

Public methods

addMediaItem

public final void addMediaItem(MediaItem mediaItem)

Adds a media item to the end of the playlist.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`MediaItem mediaItem`	The `MediaItem` to add.

addMediaItem

public final void addMediaItem(int index, MediaItem mediaItem)

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

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`int index`	The index at which to add the media item. If the index is larger than the size of the playlist, the media item is added to the end of the playlist.
`MediaItem mediaItem`	The `MediaItem` to add.

addMediaItems

public final void addMediaItems(List<MediaItem> mediaItems)

Adds a list of media items to the end of the playlist.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`List<MediaItem> mediaItems`	The `media items` to add.

canAdvertiseSession

public final boolean canAdvertiseSession()

Returns whether the player can be used to advertise a media session.

BasePlayer and its descendants will return true.

clearMediaItems

public final void clearMediaItems()

Clears the playlist.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

getBufferedPercentage

public final int getBufferedPercentage()

Returns an estimate of the percentage in the current content or ad up to which data is buffered, or 0 if no estimate is available.

getContentDuration

public final long getContentDuration()

If isPlayingAd returns true, returns the duration of the current content in milliseconds, or TIME_UNSET if the duration is not known. If there is no ad playing, the returned duration is the same as that returned by getDuration.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getCurrentLiveOffset

public final long getCurrentLiveOffset()

Returns the offset of the current playback position from the live edge in milliseconds, or TIME_UNSET if the current MediaItemisn't live or the offset is unknown.

The offset is calculated as currentTime - playbackPosition, so should usually be positive.

Note that this offset may rely on an accurate local time, so this method may return an incorrect value if the difference between system clock and server clock is unknown.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getCurrentManifest

public final @Nullable Object getCurrentManifest()

Returns the current manifest. The type depends on the type of media being played. May be null.

getCurrentMediaItem

public final @Nullable MediaItem getCurrentMediaItem()

Returns the currently playing MediaItem. May be null if the timeline is empty.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

See also
`onMediaItemTransition`

getCurrentWindowIndex

public final int getCurrentWindowIndex()

getMediaItemAt

public final MediaItem getMediaItemAt(int index)

Returns the MediaItem at the given index.

This method must only be called if COMMAND_GET_TIMELINE is available.

getMediaItemCount

public final int getMediaItemCount()

Returns the number of media items in the playlist.

This method must only be called if COMMAND_GET_TIMELINE is available.

getNextMediaItemIndex

public final int getNextMediaItemIndex()

Returns the index of the MediaItem that will be played if seekToNextMediaItem is called, which may depend on the current repeat mode and whether shuffle mode is enabled. Returns INDEX_UNSET if hasNextMediaItem is false.

Note: When the repeat mode is REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is REPEAT_MODE_OFF. See REPEAT_MODE_ONE for more details.

This method must only be called if COMMAND_GET_TIMELINE is available.

getNextWindowIndex

public final int getNextWindowIndex()

getPreviousMediaItemIndex

public final int getPreviousMediaItemIndex()

Returns the index of the MediaItem that will be played if seekToPreviousMediaItem is called, which may depend on the current repeat mode and whether shuffle mode is enabled. Returns INDEX_UNSET if hasPreviousMediaItem is false.

Note: When the repeat mode is REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is REPEAT_MODE_OFF. See REPEAT_MODE_ONE for more details.

This method must only be called if COMMAND_GET_TIMELINE is available.

getPreviousWindowIndex

public final int getPreviousWindowIndex()

hasNextMediaItem

public final boolean hasNextMediaItem()

Returns whether a next MediaItem exists, which may depend on the current repeat mode and whether shuffle mode is enabled.

Note: When the repeat mode is REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is REPEAT_MODE_OFF. See REPEAT_MODE_ONE for more details.

This method must only be called if COMMAND_GET_TIMELINE is available.

hasPreviousMediaItem

public final boolean hasPreviousMediaItem()

Returns whether a previous media item exists, which may depend on the current repeat mode and whether shuffle mode is enabled.

Note: When the repeat mode is REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is REPEAT_MODE_OFF. See REPEAT_MODE_ONE for more details.

This method must only be called if COMMAND_GET_TIMELINE is available.

isCommandAvailable

public final boolean isCommandAvailable(@Player.Command int command)

Returns whether the provided Command is available.

This method does not execute the command.

Parameters
`@Player.Command int command`	A `Command`.

Returns
`boolean`	Whether the `Command` is available.

See also
`onAvailableCommandsChanged`

isCurrentMediaItemDynamic

public final boolean isCurrentMediaItemDynamic()

Returns whether the current MediaItem is dynamic (may change when the Timeline is updated), or false if the Timeline is empty.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

See also
`isDynamic`

isCurrentMediaItemLive

public final boolean isCurrentMediaItemLive()

Returns whether the current MediaItem is live, or false if the Timeline is empty.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

See also
`isLive`

isCurrentMediaItemSeekable

public final boolean isCurrentMediaItemSeekable()

Returns whether the current MediaItem is seekable, or false if the Timeline is empty.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

See also
`isSeekable`

isCurrentWindowDynamic

public final boolean isCurrentWindowDynamic()

isCurrentWindowLive

public final boolean isCurrentWindowLive()

isCurrentWindowSeekable

public final boolean isCurrentWindowSeekable()

isPlaying

public final boolean isPlaying()

Returns whether the player is playing, i.e. getCurrentPosition is advancing.

If false, then at least one of the following is true:

The playback state is not ready.
There is no intention to play.
Playback is suppressed for other reasons.

Returns
`boolean`	Whether the player is playing.

See also
`onIsPlayingChanged`

moveMediaItem

public final void moveMediaItem(int currentIndex, int newIndex)

Moves the media item at the current index to the new index.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`int currentIndex`	The current index of the media item to move. If the index is larger than the size of the playlist, the request is ignored.
`int newIndex`	The new index of the media item. If the new index is larger than the size of the playlist the item is moved to the end of the playlist.

pause

public final void pause()

Pauses playback. Equivalent to setPlayWhenReady(false).

This method must only be called if COMMAND_PLAY_PAUSE is available.

play

public final void play()

Resumes playback as soon as getPlaybackState == STATE_READY. Equivalent to setPlayWhenReady(true).

This method must only be called if COMMAND_PLAY_PAUSE is available.

removeMediaItem

public final void removeMediaItem(int index)

Removes the media item at the given index of the playlist.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`int index`	The index at which to remove the media item. If the index is larger than the size of the playlist, the request is ignored.

replaceMediaItem

public final void replaceMediaItem(int index, MediaItem mediaItem)

Replaces the media item at the given index of the playlist.

Implementations of this method may attempt to seamlessly continue playback if the currently playing media item is replaced with a compatible one (e.g. same URL, only metadata has changed).

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`int index`	The index at which to replace the media item. If the index is larger than the size of the playlist, the request is ignored.
`MediaItem mediaItem`	The new `MediaItem`.

seekBack

public final void seekBack()

Seeks back in the current MediaItem by getSeekBackIncrement milliseconds.

This method must only be called if COMMAND_SEEK_BACK is available.

seekForward

public final void seekForward()

Seeks forward in the current MediaItem by getSeekForwardIncrement milliseconds.

This method must only be called if COMMAND_SEEK_FORWARD is available.

seekTo

public final void seekTo(long positionMs)

Seeks to a position specified in milliseconds in the current MediaItem.

This method must only be called if COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM is available.

Parameters
`long positionMs`	The seek position in the current `MediaItem`, or `TIME_UNSET` to seek to the media item's default position.

seekTo

public final void seekTo(int mediaItemIndex, long positionMs)

Seeks to a position specified in milliseconds in the specified MediaItem.

This method must only be called if COMMAND_SEEK_TO_MEDIA_ITEM is available.

Parameters
`int mediaItemIndex`	The index of the `MediaItem`. If the index is larger than the size of the playlist, the request is ignored.
`long positionMs`	The seek position in the specified `MediaItem`, or `TIME_UNSET` to seek to the media item's default position.

seekToDefaultPosition

public final void seekToDefaultPosition()

Seeks to the default position associated with the current MediaItem. The position can depend on the type of media being played. For live streams it will typically be the live edge. For other streams it will typically be the start.

This method must only be called if COMMAND_SEEK_TO_DEFAULT_POSITION is available.

seekToDefaultPosition

public final void seekToDefaultPosition(int mediaItemIndex)

Seeks to the default position associated with the specified MediaItem. The position can depend on the type of media being played. For live streams it will typically be the live edge. For other streams it will typically be the start.

This method must only be called if COMMAND_SEEK_TO_MEDIA_ITEM is available.

Parameters
`int mediaItemIndex`	The index of the `MediaItem` whose associated default position should be seeked to. If the index is larger than the size of the playlist, the request is ignored.

seekToNext

public final void seekToNext()

Seeks to a later position in the current or next MediaItem (if available). More precisely:

If the timeline is empty or seeking is not possible, does nothing.
Otherwise, if a next media item exists, seeks to the default position of the next MediaItem.
Otherwise, if the current MediaItem is live and has not ended, seeks to the live edge of the current MediaItem.
Otherwise, does nothing.

This method must only be called if COMMAND_SEEK_TO_NEXT is available.

seekToNextMediaItem

public final void seekToNextMediaItem()

Seeks to the default position of the next MediaItem, which may depend on the current repeat mode and whether shuffle mode is enabled. Does nothing if hasNextMediaItem is false.

Note: When the repeat mode is REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is REPEAT_MODE_OFF. See REPEAT_MODE_ONE for more details.

This method must only be called if COMMAND_SEEK_TO_NEXT_MEDIA_ITEM is available.

seekToPrevious

public final void seekToPrevious()

Seeks to an earlier position in the current or previous MediaItem (if available). More precisely:

If the timeline is empty or seeking is not possible, does nothing.
Otherwise, if the current MediaItem is live and unseekable, then:
- If a previous media item exists, seeks to the default position of the previous media item.
- Otherwise, does nothing.
Otherwise, if a previous media item exists and the current position is less than getMaxSeekToPreviousPosition, seeks to the default position of the previous MediaItem.
Otherwise, seeks to 0 in the current MediaItem.

This method must only be called if COMMAND_SEEK_TO_PREVIOUS is available.

seekToPreviousMediaItem

public final void seekToPreviousMediaItem()

Seeks to the default position of the previous MediaItem, which may depend on the current repeat mode and whether shuffle mode is enabled. Does nothing if hasPreviousMediaItem is false.

Note: When the repeat mode is REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is REPEAT_MODE_OFF. See REPEAT_MODE_ONE for more details.

This method must only be called if COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM is available.

setMediaItem

public final void setMediaItem(MediaItem mediaItem)

Clears the playlist, adds the specified MediaItem and resets the position to the default position.

To replace a media item (possibly seamlessly) without clearing the playlist, use replaceMediaItem.

This method must only be called if COMMAND_SET_MEDIA_ITEM is available.

Parameters
`MediaItem mediaItem`	The new `MediaItem`.

setMediaItem

public final void setMediaItem(MediaItem mediaItem, boolean resetPosition)

Clears the playlist and adds the specified MediaItem.

To replace a media item (possibly seamlessly) without clearing the playlist, use replaceMediaItem.

This method must only be called if COMMAND_SET_MEDIA_ITEM is available.

Parameters
`MediaItem mediaItem`	The new `MediaItem`.
`boolean resetPosition`	Whether the playback position should be reset to the default position. If false, playback will start from the position defined by `getCurrentMediaItemIndex` and `getCurrentPosition`.

setMediaItem

public final void setMediaItem(MediaItem mediaItem, long startPositionMs)

Clears the playlist and adds the specified MediaItem.

To replace a media item (possibly seamlessly) without clearing the playlist, use replaceMediaItem.

This method must only be called if COMMAND_SET_MEDIA_ITEM is available.

Parameters
`MediaItem mediaItem`	The new `MediaItem`.
`long startPositionMs`	The position in milliseconds to start playback from. If `TIME_UNSET` is passed, the default position of the given `MediaItem` is used.

setMediaItems

public final void setMediaItems(List<MediaItem> mediaItems)

Clears the playlist, adds the specified media items and resets the position to the default position.

To replace a span of media items (possibly seamlessly) without clearing the playlist, use replaceMediaItems.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`List<MediaItem> mediaItems`	The new `media items`.

setPlaybackSpeed

public final void setPlaybackSpeed(float speed)

Changes the rate at which playback occurs. The pitch is not changed.

This is equivalent to setPlaybackParameters(getPlaybackParameters().withSpeed(speed)).

This method must only be called if COMMAND_SET_SPEED_AND_PITCH is available.

Parameters
`float speed`	The linear factor by which playback will be sped up. Must be higher than 0. 1 is normal speed, 2 is twice as fast, 0.5 is half normal speed.

Protected methods

seekTo

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

Seeks to a position in the specified MediaItem.

Parameters
`int mediaItemIndex`	The index of the `MediaItem`. If the original seek operation did not directly specify an index, this is the most likely implied index based on the available player state. If the implied action is to do nothing, this will be `INDEX_UNSET`.
`long positionMs`	The seek position in the specified `MediaItem` in milliseconds, or `TIME_UNSET` to seek to the media item's default position. If the original seek operation did not directly specify a position, this is the most likely implied position based on the available player state.
`@Player.Command int seekCommand`	The `Player.Command` used to trigger the seek.
`boolean isRepeatingCurrentItem`	Whether this seeks repeats the current item.