BasePlayer

Kotlin |Java

@UnstableApi
abstract class BasePlayer : 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 constructors
`BasePlayer()`

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

Protected functions
`abstract Unit`	`@ForOverride seekTo( mediaItemIndex: Int, positionMs: Long, @Player.Command seekCommand: Int, isRepeatingCurrentItem: Boolean )` Seeks to a position in the specified `MediaItem`.

Protected properties
`Timeline.Window!`	`window`

Inherited Constants

From androidx.media3.common.Player

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

From androidx.media3.common.Player

`abstract Unit`	`addListener(listener: Player.Listener!)` Registers a listener to receive all events from the player.
`abstract Unit`	`addMediaItems(index: Int, mediaItems: (Mutable)List<MediaItem!>!)` Adds a list of media items at the given index of the playlist.
`abstract Unit`	`clearVideoSurface()` Clears any `Surface`, `SurfaceHolder`, `SurfaceView` or `TextureView` currently set on the player.
`abstract Unit`	`clearVideoSurface(surface: Surface?)` Clears the `Surface` onto which video is being rendered if it matches the one passed.
`abstract Unit`	`clearVideoSurfaceHolder(surfaceHolder: SurfaceHolder?)` Clears the `SurfaceHolder` that holds the `Surface` onto which video is being rendered if it matches the one passed.
`abstract Unit`	`clearVideoSurfaceView(surfaceView: SurfaceView?)` Clears the `SurfaceView` onto which video is being rendered if it matches the one passed.
`abstract Unit`	`clearVideoTextureView(textureView: TextureView?)` Clears the `TextureView` onto which video is being rendered if it matches the one passed.
`abstract Unit`	`decreaseDeviceVolume()` This function is deprecated. Use `decreaseDeviceVolume` instead.
`abstract Unit`	`decreaseDeviceVolume(@C.VolumeFlags flags: Int)` 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 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 Unit`	`increaseDeviceVolume()` This function is deprecated. Use `increaseDeviceVolume` instead.
`abstract Unit`	`increaseDeviceVolume(@C.VolumeFlags flags: Int)` 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 Unit`	`moveMediaItems(fromIndex: Int, toIndex: Int, newIndex: Int)` Moves the media item range to the new index.
`abstract Unit`	`@UnstableApi mute()` Sets the audio volume to 0.
`abstract Unit`	`prepare()` Prepares the player.
`abstract Unit`	`release()` Releases the player.
`abstract Unit`	`removeListener(listener: Player.Listener!)` Unregister a listener registered through `addListener`.
`abstract Unit`	`removeMediaItems(fromIndex: Int, toIndex: Int)` Removes a range of media items from the playlist.
`abstract Unit`	`replaceMediaItems( fromIndex: Int, toIndex: Int, mediaItems: (Mutable)List<MediaItem!>! )` Replaces the media items at the given range of the playlist.
`abstract Unit`	`setAudioAttributes( audioAttributes: AudioAttributes!, handleAudioFocus: Boolean )` Sets the attributes for audio playback, used by the underlying audio track.
`abstract Unit`	`setDeviceMuted(muted: Boolean)` This function is deprecated. Use `setDeviceMuted` instead.
`abstract Unit`	`setDeviceMuted(muted: Boolean, @C.VolumeFlags flags: Int)` Sets the mute state of the device.
`abstract Unit`	`setDeviceVolume(volume: @IntRange(from = 0) Int)` This function is deprecated. Use `setDeviceVolume` instead.
`abstract Unit`	`setDeviceVolume(volume: @IntRange(from = 0) Int, @C.VolumeFlags flags: Int)` Sets the volume of the device with volume flags.
`abstract Unit`	`setMediaItems( mediaItems: (Mutable)List<MediaItem!>!, resetPosition: Boolean )` Clears the playlist and adds the specified `media items`.
`abstract Unit`	`setMediaItems( mediaItems: (Mutable)List<MediaItem!>!, startIndex: Int, startPositionMs: Long )` Clears the playlist and adds the specified `media items`.
`abstract Unit`	`setPlayWhenReady(playWhenReady: Boolean)` Sets whether playback should proceed when `getPlaybackState` == `STATE_READY`.
`abstract Unit`	`setPlaybackParameters(playbackParameters: PlaybackParameters!)` Attempts to set the playback parameters.
`abstract Unit`	`setPlaylistMetadata(mediaMetadata: MediaMetadata!)` Sets the playlist `MediaMetadata`.
`abstract Unit`	`setRepeatMode(@Player.RepeatMode repeatMode: Int)` Sets the `RepeatMode` to be used for playback.
`abstract Unit`	`setShuffleModeEnabled(shuffleModeEnabled: Boolean)` Sets whether shuffling of media items is enabled.
`abstract Unit`	`setTrackSelectionParameters(parameters: TrackSelectionParameters!)` Sets the parameters constraining the track selection.
`abstract Unit`	`setVideoSurface(surface: Surface?)` Sets the `Surface` onto which video will be rendered.
`abstract Unit`	`setVideoSurfaceHolder(surfaceHolder: SurfaceHolder?)` Sets the `SurfaceHolder` that holds the `Surface` onto which video will be rendered.
`abstract Unit`	`setVideoSurfaceView(surfaceView: SurfaceView?)` Sets the `SurfaceView` onto which video will be rendered.
`abstract Unit`	`setVideoTextureView(textureView: TextureView?)` Sets the `TextureView` onto which video will be rendered.
`abstract Unit`	`setVolume(volume: @FloatRange(from = 0, to = 1.0) Float)` Sets the audio volume, valid values are between 0 (silence) and 1 (unity gain, signal unchanged), inclusive.
`abstract Unit`	`stop()` Stops playback without resetting the playlist.
`abstract Unit`	`@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 constructors

BasePlayer

protected BasePlayer()

Public functions

addMediaItem

fun addMediaItem(mediaItem: MediaItem!): Unit

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

fun addMediaItem(index: Int, mediaItem: MediaItem!): Unit

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
`index: Int`	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

fun addMediaItems(mediaItems: (Mutable)List<MediaItem!>!): Unit

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
`mediaItems: (Mutable)List<MediaItem!>!`	The `media items` to add.

canAdvertiseSession

fun canAdvertiseSession(): Boolean

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

BasePlayer and its descendants will return true.

clearMediaItems

fun clearMediaItems(): Unit

Clears the playlist.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

getBufferedPercentage

fun getBufferedPercentage(): Int

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

fun getContentDuration(): Long

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

fun getCurrentLiveOffset(): Long

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

fun getCurrentManifest(): Any?

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

getCurrentMediaItem

fun getCurrentMediaItem(): MediaItem?

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

fun getCurrentWindowIndex(): Int

getMediaItemAt

fun getMediaItemAt(index: Int): MediaItem!

Returns the MediaItem at the given index.

This method must only be called if COMMAND_GET_TIMELINE is available.

getMediaItemCount

fun getMediaItemCount(): Int

Returns the number of media items in the playlist.

This method must only be called if COMMAND_GET_TIMELINE is available.

getNextMediaItemIndex

fun getNextMediaItemIndex(): Int

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

fun getNextWindowIndex(): Int

getPreviousMediaItemIndex

fun getPreviousMediaItemIndex(): Int

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

fun getPreviousWindowIndex(): Int

hasNextMediaItem

fun hasNextMediaItem(): Boolean

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

fun hasPreviousMediaItem(): Boolean

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

fun isCommandAvailable(@Player.Command command: Int): Boolean

Returns whether the provided Command is available.

This method does not execute the command.

Parameters
`@Player.Command command: Int`	A `Command`.

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

See also
`onAvailableCommandsChanged`

isCurrentMediaItemDynamic

fun isCurrentMediaItemDynamic(): Boolean

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

fun isCurrentMediaItemLive(): Boolean

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

fun isCurrentMediaItemSeekable(): Boolean

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

fun isCurrentWindowDynamic(): Boolean

isCurrentWindowLive

fun isCurrentWindowLive(): Boolean

isCurrentWindowSeekable

fun isCurrentWindowSeekable(): Boolean

isPlaying

fun isPlaying(): Boolean

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

fun moveMediaItem(currentIndex: Int, newIndex: Int): Unit

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
`currentIndex: Int`	The current index of the media item to move. If the index is larger than the size of the playlist, the request is ignored.
`newIndex: Int`	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

fun pause(): Unit

Pauses playback. Equivalent to setPlayWhenReady(false).

This method must only be called if COMMAND_PLAY_PAUSE is available.

play

fun play(): Unit

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

fun removeMediaItem(index: Int): Unit

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
`index: Int`	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

fun replaceMediaItem(index: Int, mediaItem: MediaItem!): Unit

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
`index: Int`	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

fun seekBack(): Unit

Seeks back in the current MediaItem by getSeekBackIncrement milliseconds.

This method must only be called if COMMAND_SEEK_BACK is available.

seekForward

fun seekForward(): Unit

Seeks forward in the current MediaItem by getSeekForwardIncrement milliseconds.

This method must only be called if COMMAND_SEEK_FORWARD is available.

seekTo

fun seekTo(positionMs: Long): Unit

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
`positionMs: Long`	The seek position in the current `MediaItem`, or `TIME_UNSET` to seek to the media item's default position.

seekTo

fun seekTo(mediaItemIndex: Int, positionMs: Long): Unit

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
`mediaItemIndex: Int`	The index of the `MediaItem`. If the index is larger than the size of the playlist, the request is ignored.
`positionMs: Long`	The seek position in the specified `MediaItem`, or `TIME_UNSET` to seek to the media item's default position.

seekToDefaultPosition

fun seekToDefaultPosition(): Unit

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

fun seekToDefaultPosition(mediaItemIndex: Int): Unit

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
`mediaItemIndex: Int`	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

fun seekToNext(): Unit

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

fun seekToNextMediaItem(): Unit

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

fun seekToPrevious(): Unit

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

fun seekToPreviousMediaItem(): Unit

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

fun setMediaItem(mediaItem: MediaItem!): Unit

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

fun setMediaItem(mediaItem: MediaItem!, resetPosition: Boolean): Unit

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`.
`resetPosition: Boolean`	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

fun setMediaItem(mediaItem: MediaItem!, startPositionMs: Long): Unit

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`.
`startPositionMs: Long`	The position in milliseconds to start playback from. If `TIME_UNSET` is passed, the default position of the given `MediaItem` is used.

setMediaItems

fun setMediaItems(mediaItems: (Mutable)List<MediaItem!>!): Unit

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
`mediaItems: (Mutable)List<MediaItem!>!`	The new `media items`.

setPlaybackSpeed

fun setPlaybackSpeed(speed: Float): Unit

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
`speed: Float`	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 functions

seekTo

@ForOverride
protected abstract fun seekTo(
    mediaItemIndex: Int,
    positionMs: Long,
    @Player.Command seekCommand: Int,
    isRepeatingCurrentItem: Boolean
): Unit

Seeks to a position in the specified MediaItem.

Parameters
`mediaItemIndex: Int`	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`.
`positionMs: Long`	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 seekCommand: Int`	The `Player.Command` used to trigger the seek.
`isRepeatingCurrentItem: Boolean`	Whether this seeks repeats the current item.

Protected properties

window

protected val window: Timeline.Window!