CompositionPlayer

Artifact: androidx.media3:media3-transformer

Kotlin |Java

@ExperimentalApi
class CompositionPlayer : SimpleBasePlayer

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

A Player implementation that plays compositions of media assets. The Composition specifies how the assets should be arranged, and the audio and video effects to apply to them.

CompositionPlayer instances must be accessed from a single application thread. For the vast majority of cases this should be the application's main thread. The thread on which a CompositionPlayer instance must be accessed can be explicitly specified by passing a Looper when creating the player. If no Looper is specified, then the Looper of the thread that the player is created on is used, or if that thread does not have a Looper, the Looper of the application's main thread is used. In all cases the Looper of the thread from which the player must be accessed can be queried using getApplicationLooper.

This player only supports setting the repeat mode as all of the Composition, or off.

Summary

Nested types
`class CompositionPlayer.Builder` A builder for `CompositionPlayer` instances.

Public functions
`Unit`	`addAnalyticsListener(listener: AnalyticsListener!)` Adds an `AnalyticsListener` to receive analytics events.
`Unit`	`experimentalRedrawLastFrame()` Forces the effect pipeline to redraw the effects immediately.
`Looper?`	`getPlaybackLooper()` Returns the `Looper` associated with the playback thread or null if the internal player has not been prepared.
`Boolean`	`isScrubbingModeEnabled()` Returns whether the player is optimized for scrubbing (many frequent seeks).
`Unit`	`removeAnalyticsListener(listener: AnalyticsListener!)` Removes an `AnalyticsListener`.
`Unit`	`setComposition(composition: Composition!)` Sets the `Composition` to play from the beginning.
`Unit`	`setComposition( composition: Composition!, startPositionMs: @IntRange(from = 0) Long )` Sets the `Composition` to play.
`Unit`	`setScrubbingModeEnabled(scrubbingModeEnabled: Boolean)` Sets whether to optimize the player for scrubbing (many frequent seeks).
`Unit`	`setVideoFrameMetadataListener( videoFrameMetadataListener: VideoFrameMetadataListener! )` Sets the `VideoFrameMetadataListener`.
`Unit`	`setVideoSurface(surface: Surface!, videoOutputSize: Size!)` Sets the `Surface` and `Size` to render to.

Protected functions
`SimpleBasePlayer.State!`	`getState()` Returns the current `State` of the player.
`ListenableFuture<Any!>!`	`handleClearVideoOutput(videoOutput: Any?)` Handles calls to clear the video output.
`ListenableFuture<Any!>!`	`handlePrepare()` Handles calls to `prepare`.
`ListenableFuture<Any!>!`	`handleRelease()` Handles calls to `release`.
`ListenableFuture<Any!>!`	`handleSeek( mediaItemIndex: Int, positionMs: Long, @Player.Command seekCommand: Int )` Handles calls to seekTo and other seek operations (for example, `seekToNext`).
`ListenableFuture<Any!>!`	`handleSetAudioAttributes( audioAttributes: AudioAttributes!, handleAudioFocus: Boolean )` Handles calls to set the audio attributes.
`ListenableFuture<Any!>!`	`handleSetPlayWhenReady(playWhenReady: Boolean)` Handles calls to `setPlayWhenReady`, `play` and `pause`.
`ListenableFuture<Any!>!`	`handleSetRepeatMode(@Player.RepeatMode repeatMode: Int)` Handles calls to `setRepeatMode`.
`ListenableFuture<Any!>!`	`handleSetVideoOutput(videoOutput: Any!)` Handles calls to set the video output.
`ListenableFuture<Any!>!`	`handleSetVolume( volume: Float, @C.VolumeOperationType volumeOperationType: Int )` Handles calls to `setVolume`.
`ListenableFuture<Any!>!`	`handleStop()` Handles calls to `stop`.

Public properties
`Clock!`	`clock`

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`	`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!>!, startIndex: Int, startPositionMs: Long )` Clears the playlist and adds the specified `media items`.
`abstract Unit`	`setPlaybackSpeed(speed: @FloatRange(from = 0, fromInclusive = false) Float)` Changes the rate at which playback occurs.
`abstract Unit`	`setRepeatMode(@Player.RepeatMode repeatMode: Int)` Sets the `RepeatMode` to be used for playback.
`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.

From androidx.media3.common.SimpleBasePlayer

`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.
`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.
`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).
`ListenableFuture<Any!>!`	`@ForOverride handleAddMediaItems(index: Int, mediaItems: (Mutable)List<MediaItem!>!)` Handles calls to addMediaItem and addMediaItems.
`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 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 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 handleSetPlaybackParameters(playbackParameters: PlaybackParameters!)` Handles calls to `setPlaybackParameters` or `setPlaybackSpeed`.
`ListenableFuture<Any!>!`	`@ForOverride handleSetPlaylistMetadata(playlistMetadata: MediaMetadata!)` Handles calls to `setPlaylistMetadata`.
`ListenableFuture<Any!>!`	`@ForOverride handleSetShuffleModeEnabled(shuffleModeEnabled: Boolean)` Handles calls to `setShuffleModeEnabled`.
`ListenableFuture<Any!>!`	`@ForOverride handleSetTrackSelectionParameters( trackSelectionParameters: TrackSelectionParameters! )` Handles calls to `setTrackSelectionParameters`.
`ListenableFuture<Any!>!`	`@ForOverride handleSetVolume(volume: @FloatRange(from = 0, to = 1.0) Float)` This function is deprecated. Use `handleSetVolume` instead.
`Unit`	`increaseDeviceVolume()` This function is deprecated. Use `increaseDeviceVolume` instead.
`Unit`	`increaseDeviceVolume(@C.VolumeFlags flags: Int)` Increases the volume of the device.
`Unit`	`invalidateState()` Invalidates the current state.
`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`	`seekTo( mediaItemIndex: Int, positionMs: Long, @Player.Command seekCommand: Int, isRepeatingCurrentItem: Boolean )` Seeks to a position in the specified `MediaItem`.
`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.
`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.

Inherited properties

From androidx.media3.common.BasePlayer

Timeline.Window!

window

From androidx.media3.common.SimpleBasePlayer

Looper!

applicationLooper

Public functions

addAnalyticsListener

fun addAnalyticsListener(listener: AnalyticsListener!): Unit

Adds an AnalyticsListener to receive analytics events.

This method can be called from any thread.

Parameters
`listener: AnalyticsListener!`	The listener to be added.

experimentalRedrawLastFrame

fun experimentalRedrawLastFrame(): Unit

Forces the effect pipeline to redraw the effects immediately.

The player must be built with replayable cache support.

getPlaybackLooper

fun getPlaybackLooper(): Looper?

Returns the Looper associated with the playback thread or null if the internal player has not been prepared.

This method may be called from any thread.

isScrubbingModeEnabled

fun isScrubbingModeEnabled(): Boolean

Returns whether the player is optimized for scrubbing (many frequent seeks).

See setScrubbingModeEnabled.

removeAnalyticsListener

fun removeAnalyticsListener(listener: AnalyticsListener!): Unit

Removes an AnalyticsListener.

Parameters
`listener: AnalyticsListener!`	The listener to be removed.

setComposition

fun setComposition(composition: Composition!): Unit

Sets the Composition to play from the beginning.

Calling this method is equivalent to calling setComposition with a start position at zero.

Parameters
`composition: Composition!`	The `Composition` to play. Every `EditedMediaItem` in the `Composition` must have its `durationUs` set.

setComposition

fun setComposition(
    composition: Composition!,
    startPositionMs: @IntRange(from = 0) Long
): Unit

Sets the Composition to play.

Parameters
`composition: Composition!`	The `Composition` to play. Every `EditedMediaItem` in the `Composition` must have its `durationUs` set.
`startPositionMs: @IntRange(from = 0) Long`	The position at which playback should start, in milliseconds.

setScrubbingModeEnabled

fun setScrubbingModeEnabled(scrubbingModeEnabled: Boolean): Unit

Sets whether to optimize the player for scrubbing (many frequent seeks).

The player may consume more resources in this mode, so it should only be used for short periods of time in response to user interaction (e.g. dragging on a progress bar UI element).

During scrubbing mode playback is suppressed with PLAYBACK_SUPPRESSION_REASON_SCRUBBING.

Parameters
`scrubbingModeEnabled: Boolean`	Whether scrubbing mode should be enabled.

setVideoFrameMetadataListener

fun setVideoFrameMetadataListener(
    videoFrameMetadataListener: VideoFrameMetadataListener!
): Unit

Sets the VideoFrameMetadataListener.

setVideoSurface

fun setVideoSurface(surface: Surface!, videoOutputSize: Size!): Unit

Sets the Surface and Size to render to.

Protected functions

getState

protected fun getState(): SimpleBasePlayer.State!

Returns the current State of the player.

The State should include all available commands indicating which player methods are allowed to be called.

Note that this method won't be called while asynchronous handling of player methods is in progress. This means that the implementation doesn't need to handle state changes caused by these asynchronous operations until they are done and can return the currently known state directly. The placeholder state used while these asynchronous operations are in progress can be customized by overriding getPlaceholderState if required.

handleClearVideoOutput

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.

handlePrepare

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

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.

handleSeek

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

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.

handleSetPlayWhenReady

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.

handleSetRepeatMode

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.

handleSetVideoOutput

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

protected fun handleSetVolume(
    volume: Float,
    @C.VolumeOperationType volumeOperationType: Int
): ListenableFuture<Any!>!

Handles calls to setVolume.

Will only be called if COMMAND_SET_VOLUME is available.

Parameters
`volume: 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

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.

Public properties

clock

val clock: Clock!

CompositionPlayer

Summary

Nested types

Public functions

Protected functions

Public properties

Inherited Constants

Inherited functions

Inherited properties

Public functions

addAnalyticsListener

experimentalRedrawLastFrame

getPlaybackLooper

isScrubbingModeEnabled

removeAnalyticsListener

setComposition

setComposition

setScrubbingModeEnabled

setVideoFrameMetadataListener

setVideoSurface

Protected functions

getState

handleClearVideoOutput

handlePrepare

handleRelease

handleSeek

handleSetAudioAttributes

handleSetPlayWhenReady

handleSetRepeatMode

handleSetVideoOutput

handleSetVolume

handleStop

Public properties

clock