CompositionPlayer

Artifact: androidx.media3:media3-transformer

Kotlin |Java

@ExperimentalApi
public final class CompositionPlayer extends SimpleBasePlayer

java.lang.Object
↳	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
`public final class CompositionPlayer.Builder` A builder for `CompositionPlayer` instances.

Public fields
`final Clock`	`clock`

Public methods
`void`	`addAnalyticsListener(AnalyticsListener listener)` Adds an `AnalyticsListener` to receive analytics events.
`void`	`experimentalRedrawLastFrame()` Forces the effect pipeline to redraw the effects immediately.
`Clock`	`getClock()` Returns the `Clock` used for playback.
`@Nullable 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).
`void`	`removeAnalyticsListener(AnalyticsListener listener)` Removes an `AnalyticsListener`.
`void`	`setComposition(Composition composition)` Sets the `Composition` to play from the beginning.
`void`	`setComposition( Composition composition, @IntRange(from = 0) long startPositionMs )` Sets the `Composition` to play.
`void`	`setScrubbingModeEnabled(boolean scrubbingModeEnabled)` Sets whether to optimize the player for scrubbing (many frequent seeks).
`void`	`setVideoFrameMetadataListener( VideoFrameMetadataListener videoFrameMetadataListener )` Sets the `VideoFrameMetadataListener`.
`void`	`setVideoSurface(Surface surface, Size videoOutputSize)` Sets the `Surface` and `Size` to render to.

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

Inherited Constants

From androidx.media3.common.Player

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

Inherited fields

From androidx.media3.common.BasePlayer

final Timeline.Window

window

From androidx.media3.common.SimpleBasePlayer

final Looper

applicationLooper

Inherited methods

From androidx.media3.common.BasePlayer

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

From androidx.media3.common.Player

`abstract void`	`setDeviceVolume(@IntRange(from = 0) int volume)` This method is deprecated. Use `setDeviceVolume` instead.
`abstract void`	`setDeviceVolume(@IntRange(from = 0) int volume, @C.VolumeFlags int flags)` Sets the volume of the device with volume flags.
`abstract void`	`setMediaItems( List<MediaItem> mediaItems, int startIndex, long startPositionMs )` Clears the playlist and adds the specified `media items`.
`abstract void`	`setPlaybackSpeed(@FloatRange(from = 0, fromInclusive = false) float speed)` Changes the rate at which playback occurs.
`abstract void`	`setRepeatMode(@Player.RepeatMode int repeatMode)` Sets the `RepeatMode` to be used for playback.
`abstract void`	`setVolume(@FloatRange(from = 0, to = 1.0) float volume)` Sets the audio volume, valid values are between 0 (silence) and 1 (unity gain, signal unchanged), inclusive.

From androidx.media3.common.SimpleBasePlayer

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

clock

public final Clock clock

Public methods

addAnalyticsListener

public void addAnalyticsListener(AnalyticsListener listener)

Adds an AnalyticsListener to receive analytics events.

This method can be called from any thread.

Parameters
`AnalyticsListener listener`	The listener to be added.

experimentalRedrawLastFrame

public void experimentalRedrawLastFrame()

Forces the effect pipeline to redraw the effects immediately.

The player must be built with replayable cache support.

getClock

public Clock getClock()

Returns the Clock used for playback.

This method can be called from any thread.

getPlaybackLooper

public @Nullable Looper getPlaybackLooper()

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

public boolean isScrubbingModeEnabled()

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

See setScrubbingModeEnabled.

removeAnalyticsListener

public void removeAnalyticsListener(AnalyticsListener listener)

Removes an AnalyticsListener.

Parameters
`AnalyticsListener listener`	The listener to be removed.

setComposition

public void setComposition(Composition composition)

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

public void setComposition(
    Composition composition,
    @IntRange(from = 0) long startPositionMs
)

Sets the Composition to play.

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

setScrubbingModeEnabled

public void setScrubbingModeEnabled(boolean scrubbingModeEnabled)

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
`boolean scrubbingModeEnabled`	Whether scrubbing mode should be enabled.

setVideoFrameMetadataListener

public void setVideoFrameMetadataListener(
    VideoFrameMetadataListener videoFrameMetadataListener
)

Sets the VideoFrameMetadataListener.

setVideoSurface

public void setVideoSurface(Surface surface, Size videoOutputSize)

Sets the Surface and Size to render to.

Protected methods

getState

protected SimpleBasePlayer.State getState()

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 ListenableFuture<Object> handleClearVideoOutput(@Nullable Object videoOutput)

Handles calls to clear the video output.

Will only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`@Nullable Object videoOutput`	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<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handlePrepare

protected ListenableFuture<Object> handlePrepare()

Handles calls to prepare.

Will only be called if COMMAND_PREPARE is available.

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

handleRelease

protected ListenableFuture<Object> handleRelease()

Handles calls to release.

Will only be called if COMMAND_RELEASE is available.

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

handleSeek

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

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
`int mediaItemIndex`	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`.
`long positionMs`	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 int seekCommand`	The `Player.Command` used to trigger the seek.

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

handleSetAudioAttributes

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

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.
`boolean handleAudioFocus`	True if the player should handle audio focus, false otherwise.

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

handleSetPlayWhenReady

protected ListenableFuture<Object> handleSetPlayWhenReady(boolean playWhenReady)

Handles calls to setPlayWhenReady, play and pause.

Will only be called if COMMAND_PLAY_PAUSE is available.

Parameters
`boolean playWhenReady`	The requested `playWhenReady`

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

handleSetRepeatMode

protected ListenableFuture<Object> handleSetRepeatMode(@Player.RepeatMode int repeatMode)

Handles calls to setRepeatMode.

Will only be called if COMMAND_SET_REPEAT_MODE is available.

Parameters
`@Player.RepeatMode int repeatMode`	The requested `RepeatMode`.

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

handleSetVideoOutput

protected ListenableFuture<Object> handleSetVideoOutput(Object videoOutput)

Handles calls to set the video output.

Will only be called if COMMAND_SET_VIDEO_SURFACE is available.

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

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

handleSetVolume

protected ListenableFuture<Object> handleSetVolume(
    float volume,
    @C.VolumeOperationType int volumeOperationType
)

Handles calls to setVolume.

Will only be called if COMMAND_SET_VOLUME is available.

Parameters
`float volume`	The requested audio volume, with 0 being silence and 1 being unity gain (signal unchanged).
`@C.VolumeOperationType int volumeOperationType`	The `C.VolumeOperationType` that corresponds to the original command for changing of the volume.

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

handleStop

protected ListenableFuture<Object> handleStop()

Handles calls to stop.

Will only be called if COMMAND_STOP is available.

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

CompositionPlayer

Summary

Nested types

Public fields

Public methods

Protected methods

Inherited Constants

Inherited fields

Inherited methods

Public fields

clock

Public methods

addAnalyticsListener

experimentalRedrawLastFrame

getClock

getPlaybackLooper

isScrubbingModeEnabled

removeAnalyticsListener

setComposition

setComposition

setScrubbingModeEnabled

setVideoFrameMetadataListener

setVideoSurface

Protected methods

getState

handleClearVideoOutput

handlePrepare

handleRelease

handleSeek

handleSetAudioAttributes

handleSetPlayWhenReady

handleSetRepeatMode

handleSetVideoOutput

handleSetVolume

handleStop