ForwardingPlayer

Kotlin |Java

@UnstableApi
public class ForwardingPlayer implements Player

A Player that forwards method calls to another Player. Applications can use this class to suppress or modify specific operations, by overriding the respective methods.

Subclasses must ensure they maintain consistency with the Player interface, including interactions with Player.Listener, which can be quite fiddly. For example, if removing an available Player.Command and disabling the corresponding method, subclasses need to:

Override isCommandAvailable and getAvailableCommands
Override and no-op the method itself
Override addListener and wrap the provided Player.Listener with an implementation that drops calls to onAvailableCommandsChanged and onEvents if they were only triggered by a change in command availability that is 'invisible' after the command removal.

Many customization use-cases are instead better served by ForwardingSimpleBasePlayer, which allows subclasses to more concisely modify the behavior of an operation, or disallow a Player.Command. In many cases ForwardingSimpleBasePlayer should be used in preference to ForwardingPlayer.

Summary

Public constructors
`ForwardingPlayer(Player player)` Creates a new instance that forwards all operations to `player`.

Public methods
`void`	`addListener(Player.Listener listener)` Calls `addListener` on the delegate.
`void`	`addMediaItem(MediaItem mediaItem)` Calls `addMediaItem` on the delegate.
`void`	`addMediaItem(int index, MediaItem mediaItem)` Calls `addMediaItem` on the delegate.
`void`	`addMediaItems(List<MediaItem> mediaItems)` Calls `addMediaItems` on the delegate.
`void`	`addMediaItems(int index, List<MediaItem> mediaItems)` Calls `addMediaItems` on the delegate.
`boolean`	`canAdvertiseSession()` Calls `canAdvertiseSession` on the delegate and returns the result.
`void`	`clearMediaItems()` Calls `clearMediaItems` on the delegate.
`void`	`clearVideoSurface()` Calls `clearVideoSurface` on the delegate.
`void`	`clearVideoSurface(@Nullable Surface surface)` Calls `clearVideoSurface` on the delegate.
`void`	`clearVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)` Calls `clearVideoSurfaceHolder` on the delegate.
`void`	`clearVideoSurfaceView(@Nullable SurfaceView surfaceView)` Calls `clearVideoSurfaceView` on the delegate.
`void`	`clearVideoTextureView(@Nullable TextureView textureView)` Calls `clearVideoTextureView` on the delegate.
`void`	`decreaseDeviceVolume()` This method is deprecated. Use `decreaseDeviceVolume` instead.
`void`	`decreaseDeviceVolume(@C.VolumeFlags int flags)` Calls `decreaseDeviceVolume` on the delegate.
`Looper`	`getApplicationLooper()` Calls `getApplicationLooper` on the delegate and returns the result.
`AudioAttributes`	`getAudioAttributes()` Calls `getAudioAttributes` on the delegate and returns the result.
`Player.Commands`	`getAvailableCommands()` Calls `getAvailableCommands` on the delegate and returns the result.
`int`	`getBufferedPercentage()` Calls `getBufferedPercentage` on the delegate and returns the result.
`long`	`getBufferedPosition()` Calls `getBufferedPosition` on the delegate and returns the result.
`long`	`getContentBufferedPosition()` Calls `getContentBufferedPosition` on the delegate and returns the result.
`long`	`getContentDuration()` Calls `getContentDuration` on the delegate and returns the result.
`long`	`getContentPosition()` Calls `getContentPosition` on the delegate and returns the result.
`int`	`getCurrentAdGroupIndex()` Calls `getCurrentAdGroupIndex` on the delegate and returns the result.
`int`	`getCurrentAdIndexInAdGroup()` Calls `getCurrentAdIndexInAdGroup` on the delegate and returns the result.
`CueGroup`	`getCurrentCues()` Calls `getCurrentCues` on the delegate and returns the result.
`long`	`getCurrentLiveOffset()` Calls `getCurrentLiveOffset` on the delegate and returns the result.
`@Nullable Object`	`getCurrentManifest()` Calls `getCurrentManifest` on the delegate and returns the result.
`@Nullable MediaItem`	`getCurrentMediaItem()` Calls `getCurrentMediaItem` on the delegate and returns the result.
`int`	`getCurrentMediaItemIndex()` Calls `getCurrentMediaItemIndex` on the delegate and returns the result.
`int`	`getCurrentPeriodIndex()` Calls `getCurrentPeriodIndex` on the delegate and returns the result.
`long`	`getCurrentPosition()` Calls `getCurrentPosition` on the delegate and returns the result.
`Timeline`	`getCurrentTimeline()` Calls `getCurrentTimeline` on the delegate and returns the result.
`Tracks`	`getCurrentTracks()` Calls `getCurrentTracks` on the delegate and returns the result.
`int`	`getCurrentWindowIndex()` This method is deprecated. Use `getCurrentMediaItemIndex` instead.
`DeviceInfo`	`getDeviceInfo()` Calls `getDeviceInfo` on the delegate and returns the result.
`int`	`getDeviceVolume()` Calls `getDeviceVolume` on the delegate and returns the result.
`long`	`getDuration()` Calls `getDuration` on the delegate and returns the result.
`long`	`getMaxSeekToPreviousPosition()` Calls `getMaxSeekToPreviousPosition` on the delegate and returns the result.
`MediaItem`	`getMediaItemAt(int index)` Calls `getMediaItemAt` on the delegate and returns the result.
`int`	`getMediaItemCount()` Calls `getMediaItemCount` on the delegate and returns the result.
`MediaMetadata`	`getMediaMetadata()` Calls `getMediaMetadata` on the delegate and returns the result.
`int`	`getNextMediaItemIndex()` Calls `getNextMediaItemIndex` on the delegate and returns the result.
`int`	`getNextWindowIndex()` This method is deprecated. Use `getNextMediaItemIndex` instead.
`boolean`	`getPlayWhenReady()` Calls `getPlayWhenReady` on the delegate and returns the result.
`PlaybackParameters`	`getPlaybackParameters()` Calls `getPlaybackParameters` on the delegate and returns the result.
`int`	`getPlaybackState()` Calls `getPlaybackState` on the delegate and returns the result.
`int`	`getPlaybackSuppressionReason()` Calls `getPlaybackSuppressionReason` on the delegate and returns the result.
`@Nullable PlaybackException`	`getPlayerError()` Calls `getPlayerError` on the delegate and returns the result.
`MediaMetadata`	`getPlaylistMetadata()` Calls `getPlaylistMetadata` on the delegate and returns the result.
`int`	`getPreviousMediaItemIndex()` Calls `getPreviousMediaItemIndex` on the delegate and returns the result.
`int`	`getPreviousWindowIndex()` This method is deprecated. Use `getPreviousMediaItemIndex` instead.
`int`	`getRepeatMode()` Calls `getRepeatMode` on the delegate and returns the result.
`long`	`getSeekBackIncrement()` Calls `getSeekBackIncrement` on the delegate and returns the result.
`long`	`getSeekForwardIncrement()` Calls `getSeekForwardIncrement` on the delegate and returns the result.
`boolean`	`getShuffleModeEnabled()` Calls `getShuffleModeEnabled` on the delegate and returns the result.
`Size`	`getSurfaceSize()` Calls `getSurfaceSize` on the delegate and returns the result.
`long`	`getTotalBufferedDuration()` Calls `getTotalBufferedDuration` on the delegate and returns the result.
`TrackSelectionParameters`	`getTrackSelectionParameters()` Calls `getTrackSelectionParameters` on the delegate and returns the result.
`VideoSize`	`getVideoSize()` Calls `getVideoSize` on the delegate and returns the result.
`float`	`getVolume()` Calls `getVolume` on the delegate and returns the result.
`Player`	`getWrappedPlayer()` Returns the `Player` to which operations are forwarded.
`boolean`	`hasNext()` This method is deprecated. Use `hasNextMediaItem` instead.
`boolean`	`hasNextMediaItem()` Calls `hasNextMediaItem` on the delegate and returns the result.
`boolean`	`hasNextWindow()` This method is deprecated. Use `hasNextMediaItem` instead.
`boolean`	`hasPreviousMediaItem()` Calls `hasPreviousMediaItem` on the delegate and returns the result.
`void`	`increaseDeviceVolume()` This method is deprecated. Use `increaseDeviceVolume` instead.
`void`	`increaseDeviceVolume(@C.VolumeFlags int flags)` Calls `increaseDeviceVolume` on the delegate.
`boolean`	`isCommandAvailable(@Player.Command int command)` Calls `isCommandAvailable` on the delegate and returns the result.
`boolean`	`isCurrentMediaItemDynamic()` Calls `isCurrentMediaItemDynamic` on the delegate and returns the result.
`boolean`	`isCurrentMediaItemLive()` Calls `isCurrentMediaItemLive` on the delegate and returns the result.
`boolean`	`isCurrentMediaItemSeekable()` Calls `isCurrentMediaItemSeekable` on the delegate and returns the result.
`boolean`	`isCurrentWindowDynamic()` This method is deprecated. Use `isCurrentMediaItemDynamic` instead.
`boolean`	`isCurrentWindowLive()` This method is deprecated. Use `isCurrentMediaItemLive` instead.
`boolean`	`isCurrentWindowSeekable()` This method is deprecated. Use `isCurrentMediaItemSeekable` instead.
`boolean`	`isDeviceMuted()` Calls `isDeviceMuted` on the delegate and returns the result.
`boolean`	`isLoading()` Calls `isLoading` on the delegate and returns the result.
`boolean`	`isPlaying()` Calls `isPlaying` on the delegate and returns the result.
`boolean`	`isPlayingAd()` Calls `isPlayingAd` on the delegate and returns the result.
`void`	`moveMediaItem(int currentIndex, int newIndex)` Calls `moveMediaItem` on the delegate.
`void`	`moveMediaItems(int fromIndex, int toIndex, int newIndex)` Calls `moveMediaItems` on the delegate.
`void`	`next()` This method is deprecated. Use `seekToNextMediaItem` instead.
`void`	`pause()` Calls `pause` on the delegate.
`void`	`play()` Calls `play` on the delegate.
`void`	`prepare()` Calls `prepare` on the delegate.
`void`	`release()` Calls `release` on the delegate.
`void`	`removeListener(Player.Listener listener)` Calls `removeListener` on the delegate.
`void`	`removeMediaItem(int index)` Calls `removeMediaItem` on the delegate.
`void`	`removeMediaItems(int fromIndex, int toIndex)` Calls `removeMediaItems` on the delegate.
`void`	`replaceMediaItem(int index, MediaItem mediaItem)` Calls `replaceMediaItem` on the delegate.
`void`	`replaceMediaItems( int fromIndex, int toIndex, List<MediaItem> mediaItems )` Calls `replaceMediaItems` on the delegate.
`void`	`seekBack()` Calls `seekBack` on the delegate.
`void`	`seekForward()` Calls `seekForward` on the delegate.
`void`	`seekTo(long positionMs)` Calls `seekTo` on the delegate.
`void`	`seekTo(int mediaItemIndex, long positionMs)` Calls `seekTo` on the delegate.
`void`	`seekToDefaultPosition()` Calls `seekToDefaultPosition` on the delegate.
`void`	`seekToDefaultPosition(int mediaItemIndex)` Calls `seekToDefaultPosition` on the delegate.
`void`	`seekToNext()` Calls `seekToNext` on the delegate.
`void`	`seekToNextMediaItem()` Calls `seekToNextMediaItem` on the delegate.
`void`	`seekToNextWindow()` This method is deprecated. Use `seekToNextMediaItem` instead.
`void`	`seekToPrevious()` Calls `seekToPrevious` on the delegate.
`void`	`seekToPreviousMediaItem()` Calls `seekToPreviousMediaItem` on the delegate.
`void`	`seekToPreviousWindow()` This method is deprecated. Use `seekToPreviousMediaItem` instead.
`void`	`setAudioAttributes( AudioAttributes audioAttributes, boolean handleAudioFocus )` Calls `setAudioAttributes` on the delegate.
`void`	`setDeviceMuted(boolean muted)` This method is deprecated. Use `setDeviceMuted` instead.
`void`	`setDeviceMuted(boolean muted, @C.VolumeFlags int flags)` Calls `setDeviceMuted` on the delegate.
`void`	`setDeviceVolume(int volume)` This method is deprecated. Use `setDeviceVolume` instead.
`void`	`setDeviceVolume(int volume, @C.VolumeFlags int flags)` Calls `setDeviceVolume` on the delegate.
`void`	`setMediaItem(MediaItem mediaItem)` Calls `setMediaItem` on the delegate.
`void`	`setMediaItem(MediaItem mediaItem, boolean resetPosition)` Calls `setMediaItem` on the delegate.
`void`	`setMediaItem(MediaItem mediaItem, long startPositionMs)` Calls `setMediaItem` on the delegate.
`void`	`setMediaItems(List<MediaItem> mediaItems)` Calls `setMediaItems` on the delegate.
`void`	`setMediaItems(List<MediaItem> mediaItems, boolean resetPosition)` Calls `setMediaItems` ()} on the delegate.
`void`	`setMediaItems( List<MediaItem> mediaItems, int startIndex, long startPositionMs )` Calls `setMediaItems` on the delegate.
`void`	`setPlayWhenReady(boolean playWhenReady)` Calls `setPlayWhenReady` on the delegate.
`void`	`setPlaybackParameters(PlaybackParameters playbackParameters)` Calls `setPlaybackParameters` on the delegate.
`void`	`setPlaybackSpeed(float speed)` Calls `setPlaybackSpeed` on the delegate.
`void`	`setPlaylistMetadata(MediaMetadata mediaMetadata)` Calls `setPlaylistMetadata` on the delegate.
`void`	`setRepeatMode(@Player.RepeatMode int repeatMode)` Calls `setRepeatMode` on the delegate.
`void`	`setShuffleModeEnabled(boolean shuffleModeEnabled)` Calls `setShuffleModeEnabled` on the delegate.
`void`	`setTrackSelectionParameters(TrackSelectionParameters parameters)` Calls `setTrackSelectionParameters` on the delegate.
`void`	`setVideoSurface(@Nullable Surface surface)` Calls `setVideoSurface` on the delegate.
`void`	`setVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)` Calls `setVideoSurfaceHolder` on the delegate.
`void`	`setVideoSurfaceView(@Nullable SurfaceView surfaceView)` Calls `setVideoSurfaceView` on the delegate.
`void`	`setVideoTextureView(@Nullable TextureView textureView)` Calls `setVideoTextureView` on the delegate.
`void`	`setVolume(float volume)` Calls `setVolume` on the delegate.
`void`	`stop()` Calls `stop` on the delegate.

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

Public constructors

ForwardingPlayer

public ForwardingPlayer(Player player)

Creates a new instance that forwards all operations to player.

Public methods

addListener

public void addListener(Player.Listener listener)

Calls addListener on the delegate.

Overrides of this method must not directly call delegate.addListener. If the override wants to pass the Player.Listener instance to the delegate Player, it must do so by calling super.addListener instead. This ensures the correct Player instance is passed to onEvents (i.e. this forwarding instance, and not the underlying delegate instance).

addMediaItem

public void addMediaItem(MediaItem mediaItem)

Calls addMediaItem on the delegate.

addMediaItem

public void addMediaItem(int index, MediaItem mediaItem)

Calls addMediaItem on the delegate.

addMediaItems

public void addMediaItems(List<MediaItem> mediaItems)

Calls addMediaItems on the delegate.

addMediaItems

public void addMediaItems(int index, List<MediaItem> mediaItems)

Calls addMediaItems on the delegate.

canAdvertiseSession

public boolean canAdvertiseSession()

Calls canAdvertiseSession on the delegate and returns the result.

clearMediaItems

public void clearMediaItems()

Calls clearMediaItems on the delegate.

clearVideoSurface

public void clearVideoSurface()

Calls clearVideoSurface on the delegate.

clearVideoSurface

public void clearVideoSurface(@Nullable Surface surface)

Calls clearVideoSurface on the delegate.

clearVideoSurfaceHolder

public void clearVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)

Calls clearVideoSurfaceHolder on the delegate.

clearVideoSurfaceView

public void clearVideoSurfaceView(@Nullable SurfaceView surfaceView)

Calls clearVideoSurfaceView on the delegate.

clearVideoTextureView

public void clearVideoTextureView(@Nullable TextureView textureView)

Calls clearVideoTextureView on the delegate.

decreaseDeviceVolume

public void decreaseDeviceVolume()

decreaseDeviceVolume

public void decreaseDeviceVolume(@C.VolumeFlags int flags)

Calls decreaseDeviceVolume on the delegate.

getApplicationLooper

public Looper getApplicationLooper()

Calls getApplicationLooper on the delegate and returns the result.

getAudioAttributes

public AudioAttributes getAudioAttributes()

Calls getAudioAttributes on the delegate and returns the result.

getAvailableCommands

public Player.Commands getAvailableCommands()

Calls getAvailableCommands on the delegate and returns the result.

getBufferedPercentage

public int getBufferedPercentage()

Calls getBufferedPercentage on the delegate and returns the result.

getBufferedPosition

public long getBufferedPosition()

Calls getBufferedPosition on the delegate and returns the result.

getContentBufferedPosition

public long getContentBufferedPosition()

Calls getContentBufferedPosition on the delegate and returns the result.

getContentDuration

public long getContentDuration()

Calls getContentDuration on the delegate and returns the result.

getContentPosition

public long getContentPosition()

Calls getContentPosition on the delegate and returns the result.

getCurrentAdGroupIndex

public int getCurrentAdGroupIndex()

Calls getCurrentAdGroupIndex on the delegate and returns the result.

getCurrentAdIndexInAdGroup

public int getCurrentAdIndexInAdGroup()

Calls getCurrentAdIndexInAdGroup on the delegate and returns the result.

getCurrentCues

public CueGroup getCurrentCues()

Calls getCurrentCues on the delegate and returns the result.

getCurrentLiveOffset

public long getCurrentLiveOffset()

Calls getCurrentLiveOffset on the delegate and returns the result.

getCurrentManifest

public @Nullable Object getCurrentManifest()

Calls getCurrentManifest on the delegate and returns the result.

getCurrentMediaItem

public @Nullable MediaItem getCurrentMediaItem()

Calls getCurrentMediaItem on the delegate and returns the result.

getCurrentMediaItemIndex

public int getCurrentMediaItemIndex()

Calls getCurrentMediaItemIndex on the delegate and returns the result.

getCurrentPeriodIndex

public int getCurrentPeriodIndex()

Calls getCurrentPeriodIndex on the delegate and returns the result.

getCurrentPosition

public long getCurrentPosition()

Calls getCurrentPosition on the delegate and returns the result.

getCurrentTimeline

public Timeline getCurrentTimeline()

Calls getCurrentTimeline on the delegate and returns the result.

getCurrentTracks

public Tracks getCurrentTracks()

Calls getCurrentTracks on the delegate and returns the result.

getCurrentWindowIndex

public int getCurrentWindowIndex()

Calls getCurrentWindowIndex on the delegate and returns the result.

getDeviceInfo

public DeviceInfo getDeviceInfo()

Calls getDeviceInfo on the delegate and returns the result.

getDeviceVolume

public int getDeviceVolume()

Calls getDeviceVolume on the delegate and returns the result.

getDuration

public long getDuration()

Calls getDuration on the delegate and returns the result.

getMaxSeekToPreviousPosition

public long getMaxSeekToPreviousPosition()

Calls getMaxSeekToPreviousPosition on the delegate and returns the result.

getMediaItemAt

public MediaItem getMediaItemAt(int index)

Calls getMediaItemAt on the delegate and returns the result.

getMediaItemCount

public int getMediaItemCount()

Calls getMediaItemCount on the delegate and returns the result.

getMediaMetadata

public MediaMetadata getMediaMetadata()

Calls getMediaMetadata on the delegate and returns the result.

getNextMediaItemIndex

public int getNextMediaItemIndex()

Calls getNextMediaItemIndex on the delegate and returns the result.

getNextWindowIndex

public int getNextWindowIndex()

Calls getNextWindowIndex on the delegate and returns the result.

getPlayWhenReady

public boolean getPlayWhenReady()

Calls getPlayWhenReady on the delegate and returns the result.

getPlaybackParameters

public PlaybackParameters getPlaybackParameters()

Calls getPlaybackParameters on the delegate and returns the result.

getPlaybackState

public int getPlaybackState()

Calls getPlaybackState on the delegate and returns the result.

getPlaybackSuppressionReason

public int getPlaybackSuppressionReason()

Calls getPlaybackSuppressionReason on the delegate and returns the result.

getPlayerError

public @Nullable PlaybackException getPlayerError()

Calls getPlayerError on the delegate and returns the result.

getPlaylistMetadata

public MediaMetadata getPlaylistMetadata()

Calls getPlaylistMetadata on the delegate and returns the result.

getPreviousMediaItemIndex

public int getPreviousMediaItemIndex()

Calls getPreviousMediaItemIndex on the delegate and returns the result.

getPreviousWindowIndex

public int getPreviousWindowIndex()

Calls getPreviousWindowIndex on the delegate and returns the result.

getRepeatMode

public int getRepeatMode()

Calls getRepeatMode on the delegate and returns the result.

getSeekBackIncrement

public long getSeekBackIncrement()

Calls getSeekBackIncrement on the delegate and returns the result.

getSeekForwardIncrement

public long getSeekForwardIncrement()

Calls getSeekForwardIncrement on the delegate and returns the result.

getShuffleModeEnabled

public boolean getShuffleModeEnabled()

Calls getShuffleModeEnabled on the delegate and returns the result.

getSurfaceSize

public Size getSurfaceSize()

Calls getSurfaceSize on the delegate and returns the result.

getTotalBufferedDuration

public long getTotalBufferedDuration()

Calls getTotalBufferedDuration on the delegate and returns the result.

getTrackSelectionParameters

public TrackSelectionParameters getTrackSelectionParameters()

Calls getTrackSelectionParameters on the delegate and returns the result.

getVideoSize

public VideoSize getVideoSize()

Calls getVideoSize on the delegate and returns the result.

getVolume

public float getVolume()

Calls getVolume on the delegate and returns the result.

getWrappedPlayer

public Player getWrappedPlayer()

Returns the Player to which operations are forwarded.

hasNext

public boolean hasNext()

Calls hasNext on the delegate and returns the result.

hasNextMediaItem

public boolean hasNextMediaItem()

Calls hasNextMediaItem on the delegate and returns the result.

hasNextWindow

public boolean hasNextWindow()

Calls hasNextWindow on the delegate and returns the result.

hasPreviousMediaItem

public boolean hasPreviousMediaItem()

Calls hasPreviousMediaItem on the delegate and returns the result.

increaseDeviceVolume

public void increaseDeviceVolume()

increaseDeviceVolume

public void increaseDeviceVolume(@C.VolumeFlags int flags)

Calls increaseDeviceVolume on the delegate.

isCommandAvailable

public boolean isCommandAvailable(@Player.Command int command)

Calls isCommandAvailable on the delegate and returns the result.

isCurrentMediaItemDynamic

public boolean isCurrentMediaItemDynamic()

Calls isCurrentMediaItemDynamic on the delegate and returns the result.

isCurrentMediaItemLive

public boolean isCurrentMediaItemLive()

Calls isCurrentMediaItemLive on the delegate and returns the result.

isCurrentMediaItemSeekable

public boolean isCurrentMediaItemSeekable()

Calls isCurrentMediaItemSeekable on the delegate and returns the result.

isCurrentWindowDynamic

public boolean isCurrentWindowDynamic()

Calls isCurrentWindowDynamic on the delegate and returns the result.

isCurrentWindowLive

public boolean isCurrentWindowLive()

Calls isCurrentWindowLive on the delegate and returns the result.

isCurrentWindowSeekable

public boolean isCurrentWindowSeekable()

Calls isCurrentWindowSeekable on the delegate and returns the result.

isDeviceMuted

public boolean isDeviceMuted()

Calls isDeviceMuted on the delegate and returns the result.

isLoading

public boolean isLoading()

Calls isLoading on the delegate and returns the result.

isPlaying

public boolean isPlaying()

Calls isPlaying on the delegate and returns the result.

isPlayingAd

public boolean isPlayingAd()

Calls isPlayingAd on the delegate and returns the result.

moveMediaItem

public void moveMediaItem(int currentIndex, int newIndex)

Calls moveMediaItem on the delegate.

moveMediaItems

public void moveMediaItems(int fromIndex, int toIndex, int newIndex)

Calls moveMediaItems on the delegate.

public void next()

Calls next on the delegate.

pause

public void pause()

Calls pause on the delegate.

play

public void play()

Calls play on the delegate.

prepare

public void prepare()

Calls prepare on the delegate.

release

public void release()

Calls release on the delegate.

removeListener

public void removeListener(Player.Listener listener)

Calls removeListener on the delegate.

Overrides of this method must not directly call delegate.removeListener. If the override wants to pass the Player.Listener instance to the delegate Player, it must do so by calling super.removeListener instead.

removeMediaItem

public void removeMediaItem(int index)

Calls removeMediaItem on the delegate.

removeMediaItems

public void removeMediaItems(int fromIndex, int toIndex)

Calls removeMediaItems on the delegate.

replaceMediaItem

public void replaceMediaItem(int index, MediaItem mediaItem)

Calls replaceMediaItem on the delegate.

replaceMediaItems

public void replaceMediaItems(
    int fromIndex,
    int toIndex,
    List<MediaItem> mediaItems
)

Calls replaceMediaItems on the delegate.

seekBack

public void seekBack()

Calls seekBack on the delegate.

seekForward

public void seekForward()

Calls seekForward on the delegate.

seekTo

public void seekTo(long positionMs)

Calls seekTo on the delegate.

seekTo

public void seekTo(int mediaItemIndex, long positionMs)

Calls seekTo on the delegate.

seekToDefaultPosition

public void seekToDefaultPosition()

Calls seekToDefaultPosition on the delegate.

seekToDefaultPosition

public void seekToDefaultPosition(int mediaItemIndex)

Calls seekToDefaultPosition on the delegate.

seekToNext

public void seekToNext()

Calls seekToNext on the delegate.

seekToNextMediaItem

public void seekToNextMediaItem()

Calls seekToNextMediaItem on the delegate.

seekToNextWindow

public void seekToNextWindow()

Calls seekToNextWindow on the delegate.

seekToPrevious

public void seekToPrevious()

Calls seekToPrevious on the delegate.

seekToPreviousMediaItem

public void seekToPreviousMediaItem()

Calls seekToPreviousMediaItem on the delegate.

seekToPreviousWindow

public void seekToPreviousWindow()

Calls seekToPreviousWindow on the delegate.

setAudioAttributes

public void setAudioAttributes(
    AudioAttributes audioAttributes,
    boolean handleAudioFocus
)

Calls setAudioAttributes on the delegate.

setDeviceMuted

public void setDeviceMuted(boolean muted)

setDeviceMuted

public void setDeviceMuted(boolean muted, @C.VolumeFlags int flags)

Calls setDeviceMuted on the delegate.

setDeviceVolume

public void setDeviceVolume(int volume)

setDeviceVolume

public void setDeviceVolume(int volume, @C.VolumeFlags int flags)

Calls setDeviceVolume on the delegate.

setMediaItem

public void setMediaItem(MediaItem mediaItem)

Calls setMediaItem on the delegate.

setMediaItem

public void setMediaItem(MediaItem mediaItem, boolean resetPosition)

Calls setMediaItem on the delegate.

setMediaItem

public void setMediaItem(MediaItem mediaItem, long startPositionMs)

Calls setMediaItem on the delegate.

setMediaItems

public void setMediaItems(List<MediaItem> mediaItems)

Calls setMediaItems on the delegate.

setMediaItems

public void setMediaItems(List<MediaItem> mediaItems, boolean resetPosition)

Calls setMediaItems ()} on the delegate.

setMediaItems

public void setMediaItems(
    List<MediaItem> mediaItems,
    int startIndex,
    long startPositionMs
)

Calls setMediaItems on the delegate.

setPlayWhenReady

public void setPlayWhenReady(boolean playWhenReady)

Calls setPlayWhenReady on the delegate.

setPlaybackParameters

public void setPlaybackParameters(PlaybackParameters playbackParameters)

Calls setPlaybackParameters on the delegate.

setPlaybackSpeed

public void setPlaybackSpeed(float speed)

Calls setPlaybackSpeed on the delegate.

setPlaylistMetadata

public void setPlaylistMetadata(MediaMetadata mediaMetadata)

Calls setPlaylistMetadata on the delegate.

setRepeatMode

public void setRepeatMode(@Player.RepeatMode int repeatMode)

Calls setRepeatMode on the delegate.

setShuffleModeEnabled

public void setShuffleModeEnabled(boolean shuffleModeEnabled)

Calls setShuffleModeEnabled on the delegate.

setTrackSelectionParameters

public void setTrackSelectionParameters(TrackSelectionParameters parameters)

Calls setTrackSelectionParameters on the delegate.

setVideoSurface

public void setVideoSurface(@Nullable Surface surface)

Calls setVideoSurface on the delegate.

setVideoSurfaceHolder

public void setVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)

Calls setVideoSurfaceHolder on the delegate.

setVideoSurfaceView

public void setVideoSurfaceView(@Nullable SurfaceView surfaceView)

Calls setVideoSurfaceView on the delegate.

setVideoTextureView

public void setVideoTextureView(@Nullable TextureView textureView)

Calls setVideoTextureView on the delegate.

setVolume

public void setVolume(float volume)

Calls setVolume on the delegate.

stop

public void stop()

Calls stop on the delegate.