SimpleBasePlayer

Kotlin |Java

@UnstableApi
abstract class SimpleBasePlayer : BasePlayer

kotlin.Any
↳	androidx.media3.common.BasePlayer
	↳	androidx.media3.common.SimpleBasePlayer

Known direct subclasses

CompositionPlayer, FakePlayer, ForwardingSimpleBasePlayer

`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.

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
`class SimpleBasePlayer.LivePositionSupplier : SimpleBasePlayer.PositionSupplier` A `PositionSupplier` connected to a live provider that returns a new value on each invocation until it is `disconnected` from the live source.
`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.
`class SimpleBasePlayer.MediaItemData.Builder` A builder for `MediaItemData` objects.
`class SimpleBasePlayer.PeriodData` Data describing the properties of a period inside a `MediaItemData`.
`class SimpleBasePlayer.PeriodData.Builder` A builder for `PeriodData` objects.
`interface SimpleBasePlayer.PositionSupplier` A supplier for a position.
`class SimpleBasePlayer.State` An immutable state description of the player.
`class SimpleBasePlayer.State.Builder` A builder for `State` objects.

Protected constructors
`SimpleBasePlayer(applicationLooper: Looper!)` Creates the base class.
`SimpleBasePlayer(applicationLooper: Looper!, clock: Clock!)` Creates the base class.

Public functions
`Unit`	`addListener(listener: Player.Listener!)` Registers a listener to receive all events from the player.
`Unit`	`addMediaItems(index: Int, mediaItems: (Mutable)List<MediaItem!>!)` Adds a list of media items at the given index of the playlist.
`Unit`	`clearVideoSurface()` Clears any `Surface`, `SurfaceHolder`, `SurfaceView` or `TextureView` currently set on the player.
`Unit`	`clearVideoSurface(surface: Surface?)` Clears the `Surface` onto which video is being rendered if it matches the one passed.
`Unit`	`clearVideoSurfaceHolder(surfaceHolder: SurfaceHolder?)` Clears the `SurfaceHolder` that holds the `Surface` onto which video is being rendered if it matches the one passed.
`Unit`	`clearVideoSurfaceView(surfaceView: SurfaceView?)` Clears the `SurfaceView` onto which video is being rendered if it matches the one passed.
`Unit`	`clearVideoTextureView(textureView: TextureView?)` Clears the `TextureView` onto which video is being rendered if it matches the one passed.
`Unit`	`decreaseDeviceVolume()` This function is deprecated. Use `decreaseDeviceVolume` instead.
`Unit`	`decreaseDeviceVolume(@C.VolumeFlags flags: Int)` Decreases the volume of the device.
`AudioAttributes!`	`getAudioAttributes()` Returns the attributes for audio playback.
`Int`	`getAudioSessionId()` Returns the audio session identifier, or `AUDIO_SESSION_ID_UNSET` if not set.
`Player.Commands!`	`getAvailableCommands()` Returns the player's currently available `Commands`.
`Long`	`getBufferedPosition()` Returns an estimate of the position in the current content or ad up to which data is buffered, in milliseconds.
`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.
`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.
`Int`	`getCurrentAdGroupIndex()` If `isPlayingAd` returns true, returns the index of the ad group in the period currently being played.
`Int`	`getCurrentAdIndexInAdGroup()` If `isPlayingAd` returns true, returns the index of the ad in its ad group.
`CueGroup!`	`getCurrentCues()` Returns the current `CueGroup`.
`Int`	`getCurrentMediaItemIndex()` Returns the index of the current `MediaItem` in the `timeline`, or the prospective index if the `current timeline` is empty.
`Int`	`getCurrentPeriodIndex()` Returns the index of the period currently being played.
`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.
`Timeline!`	`getCurrentTimeline()` Returns the current `Timeline`.
`Tracks!`	`getCurrentTracks()` Returns the current tracks.
`DeviceInfo!`	`getDeviceInfo()` Gets the device information.
`Int`	`getDeviceVolume()` Gets the current volume of the device.
`Long`	`getDuration()` Returns the duration of the current content or ad in milliseconds, or `TIME_UNSET` if the duration is not known.
`Long`	`getMaxSeekToPreviousPosition()` Returns the maximum position for which `seekToPrevious` seeks to the previous `MediaItem`, in milliseconds.
`MediaMetadata!`	`getMediaMetadata()` Returns the current combined `MediaMetadata`, or `EMPTY` if not supported.
`Boolean`	`getPlayWhenReady()` Whether playback will proceed when `getPlaybackState` == `STATE_READY`.
`PlaybackParameters!`	`getPlaybackParameters()` Returns the currently active playback parameters.
`Int`	`@Player.State getPlaybackState()` Returns the current `playback state` of the player.
`Int`	`getPlaybackSuppressionReason()` Returns the reason why playback is suppressed even though `getPlayWhenReady` is `true`, or `PLAYBACK_SUPPRESSION_REASON_NONE` if playback is not suppressed.
`PlaybackException?`	`getPlayerError()` Returns the error that caused playback to fail.
`MediaMetadata!`	`getPlaylistMetadata()` Returns the playlist `MediaMetadata`, as set by `setPlaylistMetadata`, or `EMPTY` if not supported.
`Int`	`@Player.RepeatMode getRepeatMode()` Returns the current `RepeatMode` used for playback.
`Long`	`getSeekBackIncrement()` Returns the `seekBack` increment.
`Long`	`getSeekForwardIncrement()` Returns the `seekForward` increment.
`Boolean`	`getShuffleModeEnabled()` Returns whether shuffling of media items is enabled.
`Size!`	`getSurfaceSize()` Gets the size of the surface on which the video is rendered.
`Long`	`getTotalBufferedDuration()` Returns an estimate of the total buffered duration from the current position, in milliseconds.
`TrackSelectionParameters!`	`getTrackSelectionParameters()` Returns the parameters constraining the track selection.
`VideoSize!`	`getVideoSize()` Gets the size of the video.
`Float`	`getVolume()` Returns the audio volume, with 0 being silence and 1 being unity gain (signal unchanged).
`Unit`	`increaseDeviceVolume()` This function is deprecated. Use `increaseDeviceVolume` instead.
`Unit`	`increaseDeviceVolume(@C.VolumeFlags flags: Int)` Increases the volume of the device.
`Boolean`	`isDeviceMuted()` Gets whether the device is muted or not.
`Boolean`	`isLoading()` Whether the player is currently loading the source.
`Boolean`	`isPlayingAd()` Returns whether the player is currently playing an ad.
`Unit`	`moveMediaItems(fromIndex: Int, toIndex: Int, newIndex: Int)` Moves the media item range to the new index.
`Unit`	`mute()` Sets the audio volume to 0.
`Unit`	`prepare()` Prepares the player.
`Unit`	`release()` Releases the player.
`Unit`	`removeListener(listener: Player.Listener!)` Unregister a listener registered through `addListener`.
`Unit`	`removeMediaItems(fromIndex: Int, toIndex: Int)` Removes a range of media items from the playlist.
`Unit`	`replaceMediaItems( fromIndex: Int, toIndex: Int, mediaItems: (Mutable)List<MediaItem!>! )` Replaces the media items at the given range of the playlist.
`Unit`	`setAudioAttributes( audioAttributes: AudioAttributes!, handleAudioFocus: Boolean )` Sets the attributes for audio playback, used by the underlying audio track.
`Unit`	`setDeviceMuted(muted: Boolean)` This function is deprecated. Use `setDeviceMuted` instead.
`Unit`	`setDeviceMuted(muted: Boolean, @C.VolumeFlags flags: Int)` Sets the mute state of the device.
`Unit`	`setDeviceVolume(volume: Int)` This function is deprecated. Use `setDeviceVolume` instead.
`Unit`	`setDeviceVolume(volume: Int, @C.VolumeFlags flags: Int)` Sets the volume of the device with volume flags.
`Unit`	`setMediaItems( mediaItems: (Mutable)List<MediaItem!>!, resetPosition: Boolean )` Clears the playlist and adds the specified `media items`.
`Unit`	`setMediaItems( mediaItems: (Mutable)List<MediaItem!>!, startIndex: Int, startPositionMs: Long )` Clears the playlist and adds the specified `media items`.
`Unit`	`setPlayWhenReady(playWhenReady: Boolean)` Sets whether playback should proceed when `getPlaybackState` == `STATE_READY`.
`Unit`	`setPlaybackParameters(playbackParameters: PlaybackParameters!)` Attempts to set the playback parameters.
`Unit`	`setPlaylistMetadata(mediaMetadata: MediaMetadata!)` Sets the playlist `MediaMetadata`.
`Unit`	`setRepeatMode(@Player.RepeatMode repeatMode: Int)` Sets the `RepeatMode` to be used for playback.
`Unit`	`setShuffleModeEnabled(shuffleModeEnabled: Boolean)` Sets whether shuffling of media items is enabled.
`Unit`	`setTrackSelectionParameters(parameters: TrackSelectionParameters!)` Sets the parameters constraining the track selection.
`Unit`	`setVideoSurface(surface: Surface?)` Sets the `Surface` onto which video will be rendered.
`Unit`	`setVideoSurfaceHolder(surfaceHolder: SurfaceHolder?)` Sets the `SurfaceHolder` that holds the `Surface` onto which video will be rendered.
`Unit`	`setVideoSurfaceView(surfaceView: SurfaceView?)` Sets the `SurfaceView` onto which video will be rendered.
`Unit`	`setVideoTextureView(textureView: TextureView?)` Sets the `TextureView` onto which video will be rendered.
`Unit`	`setVolume(volume: Float)` Sets the audio volume, valid values are between 0 (silence) and 1 (unity gain, signal unchanged), inclusive.
`Unit`	`stop()` Stops playback without resetting the playlist.
`Unit`	`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 functions
`SimpleBasePlayer.MediaItemData!`	`@ForOverride getPlaceholderMediaItemData(mediaItem: MediaItem!)` Returns the placeholder `MediaItemData` used for a new `MediaItem` added to the playlist.
`SimpleBasePlayer.State!`	`@ForOverride getPlaceholderState(suggestedPlaceholderState: SimpleBasePlayer.State!)` Returns the placeholder state used while a player method is handled asynchronously.
`ListenableFuture<Any!>!`	`@ForOverride handleAddMediaItems(index: Int, mediaItems: (Mutable)List<MediaItem!>!)` Handles calls to addMediaItem and addMediaItems.
`ListenableFuture<Any!>!`	`@ForOverride handleClearVideoOutput(videoOutput: Any?)` Handles calls to clear the video output.
`ListenableFuture<Any!>!`	`@ForOverride handleDecreaseDeviceVolume(@C.VolumeFlags flags: Int)` Handles calls to `decreaseDeviceVolume` and `decreaseDeviceVolume`.
`ListenableFuture<Any!>!`	`@ForOverride handleIncreaseDeviceVolume(@C.VolumeFlags flags: Int)` Handles calls to `increaseDeviceVolume` and `increaseDeviceVolume`.
`ListenableFuture<Any!>!`	`@ForOverride handleMoveMediaItems(fromIndex: Int, toIndex: Int, newIndex: Int)` Handles calls to `moveMediaItem` and `moveMediaItems`.
`ListenableFuture<Any!>!`	`@ForOverride handlePrepare()` Handles calls to `prepare`.
`ListenableFuture<Any!>!`	`@ForOverride handleRelease()` Handles calls to `release`.
`ListenableFuture<Any!>!`	`@ForOverride handleRemoveMediaItems(fromIndex: Int, toIndex: Int)` Handles calls to `removeMediaItem` and `removeMediaItems`.
`ListenableFuture<Any!>!`	`@ForOverride handleReplaceMediaItems( fromIndex: Int, toIndex: Int, mediaItems: (Mutable)List<MediaItem!>! )` Handles calls to `replaceMediaItem` and `replaceMediaItems`.
`ListenableFuture<Any!>!`	`@ForOverride handleSeek( mediaItemIndex: Int, positionMs: Long, @Player.Command seekCommand: Int )` Handles calls to seekTo and other seek operations (for example, `seekToNext`).
`ListenableFuture<Any!>!`	`@ForOverride handleSetAudioAttributes( audioAttributes: AudioAttributes!, handleAudioFocus: Boolean )` Handles calls to set the audio attributes.
`ListenableFuture<Any!>!`	`@ForOverride handleSetDeviceMuted(muted: Boolean, @C.VolumeFlags flags: Int)` Handles calls to `setDeviceMuted` and `setDeviceMuted`.
`ListenableFuture<Any!>!`	`@ForOverride handleSetDeviceVolume( deviceVolume: @IntRange(from = 0) Int, @C.VolumeFlags flags: Int )` Handles calls to `setDeviceVolume` and `setDeviceVolume`.
`ListenableFuture<Any!>!`	`@ForOverride handleSetMediaItems( mediaItems: (Mutable)List<MediaItem!>!, startIndex: Int, startPositionMs: Long )` Handles calls to setMediaItem and setMediaItems.
`ListenableFuture<Any!>!`	`@ForOverride handleSetPlayWhenReady(playWhenReady: Boolean)` Handles calls to `setPlayWhenReady`, `play` and `pause`.
`ListenableFuture<Any!>!`	`@ForOverride handleSetPlaybackParameters(playbackParameters: PlaybackParameters!)` Handles calls to `setPlaybackParameters` or `setPlaybackSpeed`.
`ListenableFuture<Any!>!`	`@ForOverride handleSetPlaylistMetadata(playlistMetadata: MediaMetadata!)` Handles calls to `setPlaylistMetadata`.
`ListenableFuture<Any!>!`	`@ForOverride handleSetRepeatMode(@Player.RepeatMode repeatMode: Int)` Handles calls to `setRepeatMode`.
`ListenableFuture<Any!>!`	`@ForOverride handleSetShuffleModeEnabled(shuffleModeEnabled: Boolean)` Handles calls to `setShuffleModeEnabled`.
`ListenableFuture<Any!>!`	`@ForOverride handleSetTrackSelectionParameters( trackSelectionParameters: TrackSelectionParameters! )` Handles calls to `setTrackSelectionParameters`.
`ListenableFuture<Any!>!`	`@ForOverride handleSetVideoOutput(videoOutput: Any!)` Handles calls to set the video output.
`ListenableFuture<Any!>!`	`@ForOverride handleSetVolume(volume: @FloatRange(from = 0, to = 1.0) Float)` This function is deprecated. Use `handleSetVolume` instead.
`ListenableFuture<Any!>!`	`@ForOverride handleSetVolume( volume: @FloatRange(from = 0, to = 1.0) Float, @C.VolumeOperationType volumeOperationType: Int )` Handles calls to `setVolume`.
`ListenableFuture<Any!>!`	`@ForOverride handleStop()` Handles calls to `stop`.
`Unit`	`invalidateState()` Invalidates the current state.
`Unit`	`seekTo( mediaItemIndex: Int, positionMs: Long, @Player.Command seekCommand: Int, isRepeatingCurrentItem: Boolean )` Seeks to a position in the specified `MediaItem`.
`Unit`	`verifyApplicationThread()` Throws an `IllegalStateException` if the the thread calling this method does not match the `Looper` thread that was specified upon construction of this instance.

Public properties
`Looper!`	`applicationLooper`

Protected properties
`@MonotonicNonNull SimpleBasePlayer.State!`	`@MonotonicNonNull state`

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.BasePlayer

`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.

From androidx.media3.common.Player

abstract Unit

setPlaybackSpeed(speed: @FloatRange(from = 0, fromInclusive = false) Float)

Changes the rate at which playback occurs.

Inherited properties

From androidx.media3.common.BasePlayer

Timeline.Window!

window

Protected constructors

SimpleBasePlayer

protected SimpleBasePlayer(applicationLooper: Looper!)

Creates the base class.

Parameters
`applicationLooper: Looper!`	The `Looper` that must be used for all calls to the player and that is used to call listeners on.

SimpleBasePlayer

protected SimpleBasePlayer(applicationLooper: Looper!, clock: Clock!)

Creates the base class.

Parameters
`applicationLooper: Looper!`	The `Looper` that must be used for all calls to the player and that is used to call listeners on.
`clock: Clock!`	The `Clock` that will be used by the player.

Public functions

addListener

fun addListener(listener: Player.Listener!): Unit

Registers a listener to receive all events from the player.

The listener's methods will be called on the thread associated with getApplicationLooper.

This method can be called from any thread.

Parameters
`listener: Player.Listener!`	The listener to register.

addMediaItems

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

Adds a list of media items 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 items. If the index is larger than the size of the playlist, the media items are added to the end of the playlist.
`mediaItems: (Mutable)List<MediaItem!>!`	The `media items` to add.

clearVideoSurface

fun clearVideoSurface(): Unit

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

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

clearVideoSurface

fun clearVideoSurface(surface: Surface?): Unit

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

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`surface: Surface?`	The surface to clear.

clearVideoSurfaceHolder

fun clearVideoSurfaceHolder(surfaceHolder: SurfaceHolder?): Unit

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

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`surfaceHolder: SurfaceHolder?`	The surface holder to clear.

clearVideoSurfaceView

fun clearVideoSurfaceView(surfaceView: SurfaceView?): Unit

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

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`surfaceView: SurfaceView?`	The texture view to clear.

clearVideoTextureView

fun clearVideoTextureView(textureView: TextureView?): Unit

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

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`textureView: TextureView?`	The texture view to clear.

decreaseDeviceVolume

fun decreaseDeviceVolume(): Unit

decreaseDeviceVolume

fun decreaseDeviceVolume(@C.VolumeFlags flags: Int): Unit

Decreases the volume of the device.

The getDeviceVolume device volume cannot be decreased below minVolume.

Note that this method affects the device volume. To change the volume of the current stream only, use setVolume.

This method must only be called if COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
`@C.VolumeFlags flags: Int`	Either 0 or a bitwise combination of one or more `C.VolumeFlags`.

getAudioAttributes

fun getAudioAttributes(): AudioAttributes!

Returns the attributes for audio playback.

This method must only be called if COMMAND_GET_AUDIO_ATTRIBUTES is available.

See also
`onAudioAttributesChanged`

getAudioSessionId

fun getAudioSessionId(): Int

Returns the audio session identifier, or AUDIO_SESSION_ID_UNSET if not set.

See also
`onAudioSessionIdChanged`

getAvailableCommands

fun getAvailableCommands(): Player.Commands!

Returns the player's currently available Commands.

The returned Commands are not updated when available commands change. Use onAvailableCommandsChanged to get an update when the available commands change.

Returns
`Player.Commands!`	The currently available `Commands`.

See also
`onAvailableCommandsChanged`

getBufferedPosition

fun getBufferedPosition(): Long

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

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getContentBufferedPosition

fun getContentBufferedPosition(): Long

If isPlayingAd returns true, returns an estimate of the content position in the current content up to which data is buffered, in milliseconds. If there is no ad playing, the returned position is the same as that returned by getBufferedPosition.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getContentPosition

fun getContentPosition(): 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. If there is no ad playing, the returned position is the same as that returned by getCurrentPosition.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getCurrentAdGroupIndex

fun getCurrentAdGroupIndex(): Int

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

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getCurrentAdIndexInAdGroup

fun getCurrentAdIndexInAdGroup(): Int

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

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getCurrentCues

fun getCurrentCues(): CueGroup!

Returns the current CueGroup.

This method must only be called if COMMAND_GET_TEXT is available.

See also
`onCues`

getCurrentMediaItemIndex

fun getCurrentMediaItemIndex(): Int

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

This method must only be called if COMMAND_GET_TIMELINE is available.

getCurrentPeriodIndex

fun getCurrentPeriodIndex(): Int

Returns the index of the period currently being played.

This method must only be called if COMMAND_GET_TIMELINE is available.

getCurrentPosition

fun getCurrentPosition(): 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.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getCurrentTimeline

fun getCurrentTimeline(): Timeline!

Returns the current Timeline. Never null, but may be empty.

This method must only be called if COMMAND_GET_TIMELINE is available.

See also
`onTimelineChanged`

getCurrentTracks

fun getCurrentTracks(): Tracks!

Returns the current tracks.

This method must only be called if COMMAND_GET_TRACKS is available.

See also
`onTracksChanged`

getDeviceInfo

fun getDeviceInfo(): DeviceInfo!

Gets the device information.

getDeviceVolume

fun getDeviceVolume(): Int

Gets the current volume of the device.

For devices with local playback, the volume returned by this method varies according to the current stream type. The stream type is determined by getStreamType.

For devices with remote playback, the volume of the remote device is returned.

Note that this method returns the volume of the device. To check the current stream volume, use getVolume.

This method must only be called if COMMAND_GET_DEVICE_VOLUME is available.

See also
`onDeviceVolumeChanged`

getDuration

fun getDuration(): Long

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

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getMaxSeekToPreviousPosition

fun getMaxSeekToPreviousPosition(): Long

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

Returns
`Long`	The maximum seek to previous position, in milliseconds.

See also
`onMaxSeekToPreviousPositionChanged`

getMediaMetadata

fun getMediaMetadata(): MediaMetadata!

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

This MediaMetadata is a combination of the MediaItem metadata, the static metadata in the media's Format, and any timed metadata that has been parsed from the media and output via onMetadata. If a field is populated in the mediaMetadata, it will be prioritised above the same field coming from static or timed metadata.

This method must only be called if COMMAND_GET_METADATA is available.

See also
`onMediaMetadataChanged`

getPlayWhenReady

fun getPlayWhenReady(): Boolean

Whether playback will proceed when getPlaybackState == STATE_READY.

Returns
`Boolean`	Whether playback will proceed when ready.

See also
`onPlayWhenReadyChanged`

getPlaybackParameters

fun getPlaybackParameters(): PlaybackParameters!

Returns the currently active playback parameters.

See also
`onPlaybackParametersChanged`

getPlaybackState

@Player.State
fun getPlaybackState(): Int

Returns the current playback state of the player.

Returns
`Int`	The current `playback state`.

See also
`onPlaybackStateChanged`

getPlaybackSuppressionReason

fun getPlaybackSuppressionReason(): Int

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

Returns
`Int`	The current `PlaybackSuppressionReason`.

See also
`onPlaybackSuppressionReasonChanged`

getPlayerError

fun getPlayerError(): PlaybackException?

Returns the error that caused playback to fail. This is the same error that will have been reported via onPlayerError at the time of failure. It can be queried using this method until the player is re-prepared.

Note that this method will always return null if getPlaybackState is not STATE_IDLE.

Returns
`PlaybackException?`	The error, or `null`.

See also
`onPlayerError`

getPlaylistMetadata

fun getPlaylistMetadata(): MediaMetadata!

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

This method must only be called if COMMAND_GET_METADATA is available.

See also
`onPlaylistMetadataChanged`

getRepeatMode

@Player.RepeatMode
fun getRepeatMode(): Int

Returns the current RepeatMode used for playback.

Returns
`Int`	The current repeat mode.

See also
`onRepeatModeChanged`

getSeekBackIncrement

fun getSeekBackIncrement(): Long

Returns the seekBack increment.

Returns
`Long`	The seek back increment, in milliseconds.

See also
`onSeekBackIncrementChanged`

getSeekForwardIncrement

fun getSeekForwardIncrement(): Long

Returns the seekForward increment.

Returns
`Long`	The seek forward increment, in milliseconds.

See also
`onSeekForwardIncrementChanged`

getShuffleModeEnabled

fun getShuffleModeEnabled(): Boolean

Returns whether shuffling of media items is enabled.

See also
`onShuffleModeEnabledChanged`

getSurfaceSize

fun getSurfaceSize(): Size!

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

See also
`onSurfaceSizeChanged`

getTotalBufferedDuration

fun getTotalBufferedDuration(): Long

Returns an estimate of the total buffered duration from the current position, in milliseconds. This includes pre-buffered data for subsequent ads and media items.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getTrackSelectionParameters

fun getTrackSelectionParameters(): TrackSelectionParameters!

Returns the parameters constraining the track selection.

See also
`onTrackSelectionParametersChanged`	}

getVideoSize

fun getVideoSize(): VideoSize!

Gets the size of the video.

The video's width and height are 0 if there is no supported video track or its size has not been determined yet.

See also
`onVideoSizeChanged`

getVolume

fun getVolume(): Float

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

This method must only be called if COMMAND_GET_VOLUME is available.

Returns
`Float`	The linear gain applied to all audio channels.

See also
`onVolumeChanged`

increaseDeviceVolume

fun increaseDeviceVolume(): Unit

increaseDeviceVolume

fun increaseDeviceVolume(@C.VolumeFlags flags: Int): Unit

Increases the volume of the device.

The getDeviceVolume device volume cannot be increased above maxVolume, if defined.

Note that this method affects the device volume. To change the volume of the current stream only, use setVolume.

This method must only be called if COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
`@C.VolumeFlags flags: Int`	Either 0 or a bitwise combination of one or more `C.VolumeFlags`.

isDeviceMuted

fun isDeviceMuted(): Boolean

Gets whether the device is muted or not.

Note that this method returns the mute state of the device. To check if the current stream is muted, use getVolume() == 0.

This method must only be called if COMMAND_GET_DEVICE_VOLUME is available.

See also
`onDeviceVolumeChanged`

isLoading

fun isLoading(): Boolean

Whether the player is currently loading the source.

Returns
`Boolean`	Whether the player is currently loading the source.

See also
`onIsLoadingChanged`

isPlayingAd

fun isPlayingAd(): Boolean

Returns whether the player is currently playing an ad.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

moveMediaItems

fun moveMediaItems(fromIndex: Int, toIndex: Int, newIndex: Int): Unit

Moves the media item range to the new index.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`fromIndex: Int`	The start of the range to move. If the index is larger than the size of the playlist, the request is ignored.
`toIndex: Int`	The first item not to be included in the range (exclusive). If the index is larger than the size of the playlist, items up to the end of the playlist are moved.
`newIndex: Int`	The new index of the first media item of the range. If the new index is larger than the size of the remaining playlist after removing the range, the range is moved to the end of the playlist.

mute

fun mute(): Unit

Sets the audio volume to 0.

This method must only be called if COMMAND_SET_VOLUME is available.

prepare

fun prepare(): Unit

Prepares the player.

This method must only be called if COMMAND_PREPARE is available.

This will move the player out of idle state and the player will start loading media and acquire resources needed for playback.

release

fun release(): Unit

Releases the player. This method must be called when the player is no longer required. The player must not be used after calling this method.

This method must only be called if COMMAND_RELEASE is available.

removeListener

fun removeListener(listener: Player.Listener!): Unit

Unregister a listener registered through addListener. The listener will no longer receive events.

Parameters
`listener: Player.Listener!`	The listener to unregister.

removeMediaItems

fun removeMediaItems(fromIndex: Int, toIndex: Int): Unit

Removes a range of media items from the playlist.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`fromIndex: Int`	The index at which to start removing media items. If the index is larger than the size of the playlist, the request is ignored.
`toIndex: Int`	The index of the first item to be kept (exclusive). If the index is larger than the size of the playlist, media items up to the end of the playlist are removed.

replaceMediaItems

fun replaceMediaItems(
    fromIndex: Int,
    toIndex: Int,
    mediaItems: (Mutable)List<MediaItem!>!
): Unit

Replaces the media items at the given range 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.

Note that it is possible to replace a range with an arbitrary number of new items, so that the number of removed items defined by fromIndex and toIndex does not have to match the number of added items defined by mediaItems. As result, it may also change the index of subsequent items not touched by this operation.

Parameters
`fromIndex: Int`	The start of the range. If the index is larger than the size of the playlist, the request is ignored.
`toIndex: Int`	The first item not to be included in the range (exclusive). If the index is larger than the size of the playlist, items up to the end of the playlist are replaced.
`mediaItems: (Mutable)List<MediaItem!>!`	The `media items` to replace the range with.

setAudioAttributes

fun setAudioAttributes(
    audioAttributes: AudioAttributes!,
    handleAudioFocus: Boolean
): Unit

Sets the attributes for audio playback, used by the underlying audio track. If not set, the default audio attributes will be used. They are suitable for general media playback.

Setting the audio attributes during playback may introduce a short gap in audio output as the audio track is recreated. A new audio session id will also be generated.

If tunneling is enabled by the track selector, the specified audio attributes will be ignored, but they will take effect if audio is later played without tunneling.

If audio focus should be handled, the usage must be USAGE_MEDIA or USAGE_GAME. Other usages will throw an IllegalArgumentException.

This method must only be called if COMMAND_SET_AUDIO_ATTRIBUTES is available.

Parameters
`audioAttributes: AudioAttributes!`	The attributes to use for audio playback.
`handleAudioFocus: Boolean`	True if the player should handle audio focus, false otherwise.

setDeviceMuted

fun setDeviceMuted(muted: Boolean): Unit

setDeviceMuted

fun setDeviceMuted(muted: Boolean, @C.VolumeFlags flags: Int): Unit

Sets the mute state of the device.

Note that this method affects the device volume. To mute just the current stream, use setVolume(0) instead.

This method must only be called if COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
`muted: Boolean`	Whether to set the device to be muted or not
`@C.VolumeFlags flags: Int`	Either 0 or a bitwise combination of one or more `C.VolumeFlags`.

setDeviceVolume

fun setDeviceVolume(volume: Int): Unit

setDeviceVolume

fun setDeviceVolume(volume: Int, @C.VolumeFlags flags: Int): Unit

Sets the volume of the device with volume flags.

Note that this method affects the device volume. To change the volume of the current stream only, use setVolume.

This method must only be called if COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
`volume: Int`	The volume to set.
`@C.VolumeFlags flags: Int`	Either 0 or a bitwise combination of one or more `C.VolumeFlags`.

setMediaItems

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

Clears the playlist and adds the specified media items.

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`.
`resetPosition: Boolean`	Whether the playback position should be reset to the default position in the first `Timeline.Window`. If false, playback will start from the position defined by `getCurrentMediaItemIndex` and `getCurrentPosition`.

setMediaItems

fun setMediaItems(
    mediaItems: (Mutable)List<MediaItem!>!,
    startIndex: Int,
    startPositionMs: Long
): Unit

Clears the playlist and adds the specified media items.

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`.
`startIndex: Int`	The `MediaItem` index to start playback from. If `INDEX_UNSET` is passed, the current position is not reset.
`startPositionMs: Long`	The position in milliseconds to start playback from. If `TIME_UNSET` is passed, the default position of the given `MediaItem` is used. In any case, if `startIndex` is set to `INDEX_UNSET`, this parameter is ignored and the position is not reset at all.

Throws
`androidx.media3.common.IllegalSeekPositionException`	If the provided `startIndex` is not within the bounds of the list of media items.

setPlayWhenReady

fun setPlayWhenReady(playWhenReady: Boolean): Unit

Sets whether playback should proceed when getPlaybackState == STATE_READY.

If the player is already in the ready state then this method pauses and resumes playback.

This method must only be called if COMMAND_PLAY_PAUSE is available.

Parameters
`playWhenReady: Boolean`	Whether playback should proceed when ready.

setPlaybackParameters

fun setPlaybackParameters(playbackParameters: PlaybackParameters!): Unit

Attempts to set the playback parameters. Passing DEFAULT resets the player to the default, which means there is no speed or pitch adjustment.

Playback parameters changes may cause the player to buffer. onPlaybackParametersChanged will be called whenever the currently active playback parameters change.

This method must only be called if COMMAND_SET_SPEED_AND_PITCH is available.

Parameters
`playbackParameters: PlaybackParameters!`	The playback parameters.

setPlaylistMetadata

fun setPlaylistMetadata(mediaMetadata: MediaMetadata!): Unit

Sets the playlist MediaMetadata.

This method must only be called if COMMAND_SET_PLAYLIST_METADATA is available.

setRepeatMode

fun setRepeatMode(@Player.RepeatMode repeatMode: Int): Unit

Sets the RepeatMode to be used for playback.

This method must only be called if COMMAND_SET_REPEAT_MODE is available.

Parameters
`@Player.RepeatMode repeatMode: Int`	The repeat mode.

setShuffleModeEnabled

fun setShuffleModeEnabled(shuffleModeEnabled: Boolean): Unit

Sets whether shuffling of media items is enabled.

This method must only be called if COMMAND_SET_SHUFFLE_MODE is available.

Parameters
`shuffleModeEnabled: Boolean`	Whether shuffling is enabled.

setTrackSelectionParameters

fun setTrackSelectionParameters(parameters: TrackSelectionParameters!): Unit

Sets the parameters constraining the track selection.

Unsupported parameters will be silently ignored.

Use getTrackSelectionParameters to retrieve the current parameters. For example, the following snippet restricts video to SD whilst keep other track selection parameters unchanged:

player.setTrackSelectionParameters(
  player.getTrackSelectionParameters()
        .buildUpon()
        .setMaxVideoSizeSd()
        .build())

This method must only be called if COMMAND_SET_TRACK_SELECTION_PARAMETERS is available.

setVideoSurface

fun setVideoSurface(surface: Surface?): Unit

Sets the Surface onto which video will be rendered. The caller is responsible for tracking the lifecycle of the surface, and must clear the surface by calling setVideoSurface(null) if the surface is destroyed.

If the surface is held by a SurfaceView, TextureView or SurfaceHolder then it's recommended to use setVideoSurfaceView, setVideoTextureView or setVideoSurfaceHolder rather than this method, since passing the holder allows the player to track the lifecycle of the surface automatically.

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`surface: Surface?`	The `Surface`.

setVideoSurfaceHolder

fun setVideoSurfaceHolder(surfaceHolder: SurfaceHolder?): Unit

Sets the SurfaceHolder that holds the Surface onto which video will be rendered. The player will track the lifecycle of the surface automatically.

The thread that calls the SurfaceHolder.Callback methods must be the thread associated with getApplicationLooper.

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`surfaceHolder: SurfaceHolder?`	The surface holder.

setVideoSurfaceView

fun setVideoSurfaceView(surfaceView: SurfaceView?): Unit

Sets the SurfaceView onto which video will be rendered. The player will track the lifecycle of the surface automatically.

The thread that calls the SurfaceHolder.Callback methods must be the thread associated with getApplicationLooper.

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`surfaceView: SurfaceView?`	The surface view.

setVideoTextureView

fun setVideoTextureView(textureView: TextureView?): Unit

Sets the TextureView onto which video will be rendered. The player will track the lifecycle of the surface automatically.

Consider using SurfaceView via setVideoSurfaceView instead of TextureView. SurfaceView generally causes lower battery consumption, and has better handling for HDR and secure content. See Choosing a surface type for more information.

The thread that calls the TextureView.SurfaceTextureListener methods must be the thread associated with getApplicationLooper.

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`textureView: TextureView?`	The texture view.

setVolume

fun setVolume(volume: Float): Unit

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

This method must only be called if COMMAND_SET_VOLUME is available.

Parameters
`volume: Float`	Linear output gain to apply to all audio channels.

stop

fun stop(): Unit

Stops playback without resetting the playlist. Use pause rather than this method if the intention is to pause playback.

Calling this method will cause the playback state to transition to STATE_IDLE and the player will release the loaded media and resources required for playback. The player instance can still be used by calling prepare again, and release must still be called on the player if it's no longer required.

Calling this method does not clear the playlist, reset the playback position or the playback error.

This method must only be called if COMMAND_STOP is available.

unmute

fun unmute(): Unit

If the audio volume is 0, sets the audio volume to a non-zero value decided by the Player to be the most appropriate.

This method must only be called if COMMAND_SET_VOLUME is available.

Protected functions

getPlaceholderMediaItemData

@ForOverride
protected fun getPlaceholderMediaItemData(mediaItem: MediaItem!): SimpleBasePlayer.MediaItemData!

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

An implementation only needs to override this method if it can determine a more accurate placeholder state than the default.

Parameters
`mediaItem: MediaItem!`	The `MediaItem` added to the playlist.

Returns
`SimpleBasePlayer.MediaItemData!`	The `MediaItemData` used as placeholder while adding the item to the playlist is in progress.

getPlaceholderState

@ForOverride
protected fun getPlaceholderState(suggestedPlaceholderState: SimpleBasePlayer.State!): SimpleBasePlayer.State!

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

The suggestedPlaceholderState already contains the most likely state update, for example setting playWhenReady to true if player.setPlayWhenReady(true) is called, and an implementations only needs to override this method if it can determine a more accurate placeholder state.

Parameters
`suggestedPlaceholderState: SimpleBasePlayer.State!`	The suggested placeholder `State`, including the most likely outcome of handling all pending asynchronous operations.

Returns
`SimpleBasePlayer.State!`	The placeholder `State` to use while asynchronous operations are pending.

handleAddMediaItems

@ForOverride
protected fun handleAddMediaItems(index: Int, mediaItems: (Mutable)List<MediaItem!>!): ListenableFuture<Any!>!

Handles calls to addMediaItem and addMediaItems.

Will only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`index: Int`	The index at which to add the items. The index is in the range 0 <= `index`<= `getMediaItemCount`.
`mediaItems: (Mutable)List<MediaItem!>!`	The media items to add.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleClearVideoOutput

@ForOverride
protected fun handleClearVideoOutput(videoOutput: Any?): ListenableFuture<Any!>!

Handles calls to clear the video output.

Will only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`videoOutput: Any?`	The video output to clear. If null any current output should be cleared. If non-null, the output should only be cleared if it matches the provided argument. This is either a `Surface`, `SurfaceHolder`, `TextureView` or `SurfaceView`.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleDecreaseDeviceVolume

@ForOverride
protected fun handleDecreaseDeviceVolume(@C.VolumeFlags flags: Int): ListenableFuture<Any!>!

Handles calls to decreaseDeviceVolume and decreaseDeviceVolume.

Will only be called if COMMAND_ADJUST_DEVICE_VOLUME or COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
`@C.VolumeFlags flags: Int`	Either 0 or a bitwise combination of one or more `C.VolumeFlags`.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleIncreaseDeviceVolume

@ForOverride
protected fun handleIncreaseDeviceVolume(@C.VolumeFlags flags: Int): ListenableFuture<Any!>!

Handles calls to increaseDeviceVolume and increaseDeviceVolume.

Will only be called if COMMAND_ADJUST_DEVICE_VOLUME or COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
`@C.VolumeFlags flags: Int`	Either 0 or a bitwise combination of one or more `C.VolumeFlags`.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleMoveMediaItems

@ForOverride
protected fun handleMoveMediaItems(fromIndex: Int, toIndex: Int, newIndex: Int): ListenableFuture<Any!>!

Handles calls to moveMediaItem and moveMediaItems.

Will only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`fromIndex: Int`	The start index of the items to move. The index is in the range 0 <= `fromIndex`<`getMediaItemCount`.
`toIndex: Int`	The index of the first item not to be included in the move (exclusive). The index is in the range `fromIndex`<`toIndex`<= `getMediaItemCount`.
`newIndex: Int`	The new index of the first moved item. The index is in the range `0`<= `newIndex`<= `- (toIndex - fromIndex)`.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handlePrepare

@ForOverride
protected fun handlePrepare(): ListenableFuture<Any!>!

Handles calls to prepare.

Will only be called if COMMAND_PREPARE is available.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleRelease

@ForOverride
protected fun handleRelease(): ListenableFuture<Any!>!

Handles calls to release.

Will only be called if COMMAND_RELEASE is available.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleRemoveMediaItems

@ForOverride
protected fun handleRemoveMediaItems(fromIndex: Int, toIndex: Int): ListenableFuture<Any!>!

Handles calls to removeMediaItem and removeMediaItems.

Will only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`fromIndex: Int`	The index at which to start removing media items. The index is in the range 0 <= `fromIndex`<`getMediaItemCount`.
`toIndex: Int`	The index of the first item to be kept (exclusive). The index is in the range `fromIndex`<`toIndex`<= `getMediaItemCount`.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleReplaceMediaItems

@ForOverride
protected fun handleReplaceMediaItems(
    fromIndex: Int,
    toIndex: Int,
    mediaItems: (Mutable)List<MediaItem!>!
): ListenableFuture<Any!>!

Handles calls to replaceMediaItem and replaceMediaItems.

Will only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`fromIndex: Int`	The start index of the items to replace. The index is in the range 0 <= `fromIndex`<= `getMediaItemCount`.
`toIndex: Int`	The index of the first item not to be replaced (exclusive). The index is in the range `fromIndex`<= `toIndex`<= `getMediaItemCount`.
`mediaItems: (Mutable)List<MediaItem!>!`	The media items to replace the specified range with.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSeek

@ForOverride
protected fun handleSeek(
    mediaItemIndex: Int,
    positionMs: Long,
    @Player.Command seekCommand: Int
): ListenableFuture<Any!>!

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

Will only be called if the appropriate Player.Command, for example COMMAND_SEEK_TO_MEDIA_ITEM or COMMAND_SEEK_TO_NEXT, is available.

Parameters
`mediaItemIndex: Int`	The media item index to seek to. 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 position in milliseconds to start playback from, or `TIME_UNSET` to start at the default position in the media item. 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.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetAudioAttributes

@ForOverride
protected fun handleSetAudioAttributes(
    audioAttributes: AudioAttributes!,
    handleAudioFocus: Boolean
): ListenableFuture<Any!>!

Handles calls to set the audio attributes.

Will only be called if COMMAND_SET_AUDIO_ATTRIBUTES is available.

Parameters
`audioAttributes: AudioAttributes!`	The attributes to use for audio playback.
`handleAudioFocus: Boolean`	True if the player should handle audio focus, false otherwise.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetDeviceMuted

@ForOverride
protected fun handleSetDeviceMuted(muted: Boolean, @C.VolumeFlags flags: Int): ListenableFuture<Any!>!

Handles calls to setDeviceMuted and setDeviceMuted.

Will only be called if COMMAND_ADJUST_DEVICE_VOLUME or COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
`muted: Boolean`	Whether the device was requested to be muted.
`@C.VolumeFlags flags: Int`	Either 0 or a bitwise combination of one or more `C.VolumeFlags`.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetDeviceVolume

@ForOverride
protected fun handleSetDeviceVolume(
    deviceVolume: @IntRange(from = 0) Int,
    @C.VolumeFlags flags: Int
): ListenableFuture<Any!>!

Handles calls to setDeviceVolume and setDeviceVolume.

Will only be called if COMMAND_SET_DEVICE_VOLUME or COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
`deviceVolume: @IntRange(from = 0) Int`	The requested device volume.
`@C.VolumeFlags flags: Int`	Either 0 or a bitwise combination of one or more `C.VolumeFlags`.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetMediaItems

@ForOverride
protected fun handleSetMediaItems(
    mediaItems: (Mutable)List<MediaItem!>!,
    startIndex: Int,
    startPositionMs: Long
): ListenableFuture<Any!>!

Handles calls to setMediaItem and setMediaItems.

Will only be called if COMMAND_SET_MEDIA_ITEM or COMMAND_CHANGE_MEDIA_ITEMS is available. If only COMMAND_SET_MEDIA_ITEM is available, the list of media items will always contain exactly one item.

Parameters
`mediaItems: (Mutable)List<MediaItem!>!`	The media items to add.
`startIndex: Int`	The index at which to start playback from, or `INDEX_UNSET` to start at the default item.
`startPositionMs: Long`	The position in milliseconds to start playback from, or `TIME_UNSET` to start at the default position in the media item.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetPlayWhenReady

@ForOverride
protected fun handleSetPlayWhenReady(playWhenReady: Boolean): ListenableFuture<Any!>!

Handles calls to setPlayWhenReady, play and pause.

Will only be called if COMMAND_PLAY_PAUSE is available.

Parameters
`playWhenReady: Boolean`	The requested `playWhenReady`

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetPlaybackParameters

@ForOverride
protected fun handleSetPlaybackParameters(playbackParameters: PlaybackParameters!): ListenableFuture<Any!>!

Handles calls to setPlaybackParameters or setPlaybackSpeed.

Will only be called if COMMAND_SET_SPEED_AND_PITCH is available.

Parameters
`playbackParameters: PlaybackParameters!`	The requested `PlaybackParameters`.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetPlaylistMetadata

@ForOverride
protected fun handleSetPlaylistMetadata(playlistMetadata: MediaMetadata!): ListenableFuture<Any!>!

Handles calls to setPlaylistMetadata.

Will only be called if COMMAND_SET_PLAYLIST_METADATA is available.

Parameters
`playlistMetadata: MediaMetadata!`	The requested `playlist metadata`.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetRepeatMode

@ForOverride
protected fun handleSetRepeatMode(@Player.RepeatMode repeatMode: Int): ListenableFuture<Any!>!

Handles calls to setRepeatMode.

Will only be called if COMMAND_SET_REPEAT_MODE is available.

Parameters
`@Player.RepeatMode repeatMode: Int`	The requested `RepeatMode`.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetShuffleModeEnabled

@ForOverride
protected fun handleSetShuffleModeEnabled(shuffleModeEnabled: Boolean): ListenableFuture<Any!>!

Handles calls to setShuffleModeEnabled.

Will only be called if COMMAND_SET_SHUFFLE_MODE is available.

Parameters
`shuffleModeEnabled: Boolean`	Whether shuffle mode was requested to be enabled.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetTrackSelectionParameters

@ForOverride
protected fun handleSetTrackSelectionParameters(
    trackSelectionParameters: TrackSelectionParameters!
): ListenableFuture<Any!>!

Handles calls to setTrackSelectionParameters.

Will only be called if COMMAND_SET_TRACK_SELECTION_PARAMETERS is available.

Parameters
`trackSelectionParameters: TrackSelectionParameters!`	The requested `TrackSelectionParameters`.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetVideoOutput

@ForOverride
protected fun handleSetVideoOutput(videoOutput: Any!): ListenableFuture<Any!>!

Handles calls to set the video output.

Will only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`videoOutput: Any!`	The requested video output. This is either a `Surface`, `SurfaceHolder`, `TextureView` or `SurfaceView`.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetVolume

@ForOverride
protected fun handleSetVolume(volume: @FloatRange(from = 0, to = 1.0) Float): ListenableFuture<Any!>!

handleSetVolume

@ForOverride
protected fun handleSetVolume(
    volume: @FloatRange(from = 0, to = 1.0) Float,
    @C.VolumeOperationType volumeOperationType: Int
): ListenableFuture<Any!>!

Handles calls to setVolume.

Will only be called if COMMAND_SET_VOLUME is available.

Parameters
`volume: @FloatRange(from = 0, to = 1.0) Float`	The requested audio volume, with 0 being silence and 1 being unity gain (signal unchanged).
`@C.VolumeOperationType volumeOperationType: Int`	The `C.VolumeOperationType` that corresponds to the original command for changing of the volume.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleStop

@ForOverride
protected fun handleStop(): ListenableFuture<Any!>!

Handles calls to stop.

Will only be called if COMMAND_STOP is available.

Returns
`ListenableFuture<Any!>!`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

invalidateState

protected fun invalidateState(): Unit

Invalidates the current state.

Triggers a call to getState and informs listeners if the state changed.

Note that this may not have an immediate effect while there are still player methods being handled asynchronously. The state will be invalidated automatically once these pending synchronous operations are finished and there is no need to call this method again.

seekTo

protected 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.

verifyApplicationThread

protected fun verifyApplicationThread(): Unit

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

Subclasses can use this method to verify that their own defined methods are also accessed by the correct thread.

Public properties

applicationLooper

val applicationLooper: Looper!

Protected properties

state

@MonotonicNonNull
protected val state: @MonotonicNonNull SimpleBasePlayer.State!

SimpleBasePlayer

Summary

Nested types

Protected constructors

Public functions

Protected functions

Public properties

Protected properties

Inherited Constants

Inherited functions

Inherited properties

Protected constructors

SimpleBasePlayer

SimpleBasePlayer

Public functions

addListener

addMediaItems

clearVideoSurface

clearVideoSurface

clearVideoSurfaceHolder

clearVideoSurfaceView

clearVideoTextureView

decreaseDeviceVolume

decreaseDeviceVolume

getAudioAttributes

getAudioSessionId

getAvailableCommands

getBufferedPosition

getContentBufferedPosition

getContentPosition

getCurrentAdGroupIndex

getCurrentAdIndexInAdGroup

getCurrentCues

getCurrentMediaItemIndex

getCurrentPeriodIndex

getCurrentPosition

getCurrentTimeline

getCurrentTracks

getDeviceInfo

getDeviceVolume

getDuration

getMaxSeekToPreviousPosition

getMediaMetadata

getPlayWhenReady

getPlaybackParameters

getPlaybackState

getPlaybackSuppressionReason

getPlayerError

getPlaylistMetadata

getRepeatMode

getSeekBackIncrement

getSeekForwardIncrement

getShuffleModeEnabled

getSurfaceSize

getTotalBufferedDuration

getTrackSelectionParameters

getVideoSize

getVolume

increaseDeviceVolume

increaseDeviceVolume

isDeviceMuted

isLoading

isPlayingAd

moveMediaItems

mute

prepare

release

removeListener

removeMediaItems

replaceMediaItems

setAudioAttributes

setDeviceMuted

setDeviceMuted

setDeviceVolume

setDeviceVolume

setMediaItems

setMediaItems

setPlayWhenReady

setPlaybackParameters

setPlaylistMetadata