ForwardingPlayer

Kotlin |Java

@UnstableApi
class ForwardingPlayer : Player

Known direct subclasses

CastPlayer

CastPlayer

Player implementation that can control playback both on the local device, and on a remote Cast device.

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 functions
`Unit`	`addListener(listener: Player.Listener!)` Calls `addListener` on the delegate.
`Unit`	`addMediaItem(mediaItem: MediaItem!)` Calls `addMediaItem` on the delegate.
`Unit`	`addMediaItem(index: Int, mediaItem: MediaItem!)` Calls `addMediaItem` on the delegate.
`Unit`	`addMediaItems(mediaItems: (Mutable)List<MediaItem!>!)` Calls `addMediaItems` on the delegate.
`Unit`	`addMediaItems(index: Int, mediaItems: (Mutable)List<MediaItem!>!)` Calls `addMediaItems` on the delegate.
`Boolean`	`canAdvertiseSession()` Calls `canAdvertiseSession` on the delegate and returns the result.
`Unit`	`clearMediaItems()` Calls `clearMediaItems` on the delegate.
`Unit`	`clearVideoSurface()` Calls `clearVideoSurface` on the delegate.
`Unit`	`clearVideoSurface(surface: Surface?)` Calls `clearVideoSurface` on the delegate.
`Unit`	`clearVideoSurfaceHolder(surfaceHolder: SurfaceHolder?)` Calls `clearVideoSurfaceHolder` on the delegate.
`Unit`	`clearVideoSurfaceView(surfaceView: SurfaceView?)` Calls `clearVideoSurfaceView` on the delegate.
`Unit`	`clearVideoTextureView(textureView: TextureView?)` Calls `clearVideoTextureView` on the delegate.
`Unit`	`decreaseDeviceVolume()` This function is deprecated. Use `decreaseDeviceVolume` instead.
`Unit`	`decreaseDeviceVolume(@C.VolumeFlags flags: Int)` 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.
`Int`	`getAudioSessionId()` Calls `getAudioSessionId` 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.
`Any?`	`getCurrentManifest()` Calls `getCurrentManifest` on the delegate and returns the result.
`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 function 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(index: Int)` 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 function 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.
`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 function 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`	`hasNextMediaItem()` Calls `hasNextMediaItem` on the delegate and returns the result.
`Boolean`	`hasPreviousMediaItem()` Calls `hasPreviousMediaItem` on the delegate and returns the result.
`Unit`	`increaseDeviceVolume()` This function is deprecated. Use `increaseDeviceVolume` instead.
`Unit`	`increaseDeviceVolume(@C.VolumeFlags flags: Int)` Calls `increaseDeviceVolume` on the delegate.
`Boolean`	`isCommandAvailable(@Player.Command command: Int)` 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 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`	`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.
`Unit`	`moveMediaItem(currentIndex: Int, newIndex: Int)` Calls `moveMediaItem` on the delegate.
`Unit`	`moveMediaItems(fromIndex: Int, toIndex: Int, newIndex: Int)` Calls `moveMediaItems` on the delegate.
`Unit`	`mute()` Calls `mute` on the delegate.
`Unit`	`pause()` Calls `pause` on the delegate.
`Unit`	`play()` Calls `play` on the delegate.
`Unit`	`prepare()` Calls `prepare` on the delegate.
`Unit`	`release()` Calls `release` on the delegate.
`Unit`	`removeListener(listener: Player.Listener!)` Calls `removeListener` on the delegate.
`Unit`	`removeMediaItem(index: Int)` Calls `removeMediaItem` on the delegate.
`Unit`	`removeMediaItems(fromIndex: Int, toIndex: Int)` Calls `removeMediaItems` on the delegate.
`Unit`	`replaceMediaItem(index: Int, mediaItem: MediaItem!)` Calls `replaceMediaItem` on the delegate.
`Unit`	`replaceMediaItems( fromIndex: Int, toIndex: Int, mediaItems: (Mutable)List<MediaItem!>! )` Calls `replaceMediaItems` on the delegate.
`Unit`	`seekBack()` Calls `seekBack` on the delegate.
`Unit`	`seekForward()` Calls `seekForward` on the delegate.
`Unit`	`seekTo(positionMs: Long)` Calls `seekTo` on the delegate.
`Unit`	`seekTo(mediaItemIndex: Int, positionMs: Long)` Calls `seekTo` on the delegate.
`Unit`	`seekToDefaultPosition()` Calls `seekToDefaultPosition` on the delegate.
`Unit`	`seekToDefaultPosition(mediaItemIndex: Int)` Calls `seekToDefaultPosition` on the delegate.
`Unit`	`seekToNext()` Calls `seekToNext` on the delegate.
`Unit`	`seekToNextMediaItem()` Calls `seekToNextMediaItem` on the delegate.
`Unit`	`seekToPrevious()` Calls `seekToPrevious` on the delegate.
`Unit`	`seekToPreviousMediaItem()` Calls `seekToPreviousMediaItem` on the delegate.
`Unit`	`setAudioAttributes( audioAttributes: AudioAttributes!, handleAudioFocus: Boolean )` Calls `setAudioAttributes` on the delegate.
`Unit`	`setDeviceMuted(muted: Boolean)` This function is deprecated. Use `setDeviceMuted` instead.
`Unit`	`setDeviceMuted(muted: Boolean, @C.VolumeFlags flags: Int)` Calls `setDeviceMuted` on the delegate.
`Unit`	`setDeviceVolume(volume: Int)` This function is deprecated. Use `setDeviceVolume` instead.
`Unit`	`setDeviceVolume(volume: Int, @C.VolumeFlags flags: Int)` Calls `setDeviceVolume` on the delegate.
`Unit`	`setMediaItem(mediaItem: MediaItem!)` Calls `setMediaItem` on the delegate.
`Unit`	`setMediaItem(mediaItem: MediaItem!, resetPosition: Boolean)` Calls `setMediaItem` on the delegate.
`Unit`	`setMediaItem(mediaItem: MediaItem!, startPositionMs: Long)` Calls `setMediaItem` on the delegate.
`Unit`	`setMediaItems(mediaItems: (Mutable)List<MediaItem!>!)` Calls `setMediaItems` on the delegate.
`Unit`	`setMediaItems( mediaItems: (Mutable)List<MediaItem!>!, resetPosition: Boolean )` Calls `setMediaItems` ()} on the delegate.
`Unit`	`setMediaItems( mediaItems: (Mutable)List<MediaItem!>!, startIndex: Int, startPositionMs: Long )` Calls `setMediaItems` on the delegate.
`Unit`	`setPlayWhenReady(playWhenReady: Boolean)` Calls `setPlayWhenReady` on the delegate.
`Unit`	`setPlaybackParameters(playbackParameters: PlaybackParameters!)` Calls `setPlaybackParameters` on the delegate.
`Unit`	`setPlaybackSpeed(speed: Float)` Calls `setPlaybackSpeed` on the delegate.
`Unit`	`setPlaylistMetadata(mediaMetadata: MediaMetadata!)` Calls `setPlaylistMetadata` on the delegate.
`Unit`	`setRepeatMode(@Player.RepeatMode repeatMode: Int)` Calls `setRepeatMode` on the delegate.
`Unit`	`setShuffleModeEnabled(shuffleModeEnabled: Boolean)` Calls `setShuffleModeEnabled` on the delegate.
`Unit`	`setTrackSelectionParameters(parameters: TrackSelectionParameters!)` Calls `setTrackSelectionParameters` on the delegate.
`Unit`	`setVideoSurface(surface: Surface?)` Calls `setVideoSurface` on the delegate.
`Unit`	`setVideoSurfaceHolder(surfaceHolder: SurfaceHolder?)` Calls `setVideoSurfaceHolder` on the delegate.
`Unit`	`setVideoSurfaceView(surfaceView: SurfaceView?)` Calls `setVideoSurfaceView` on the delegate.
`Unit`	`setVideoTextureView(textureView: TextureView?)` Calls `setVideoTextureView` on the delegate.
`Unit`	`setVolume(volume: Float)` Calls `setVolume` on the delegate.
`Unit`	`stop()` Calls `stop` on the delegate.
`Unit`	`unmute()` Calls `unmute` on the delegate.

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

Public constructors

ForwardingPlayer

ForwardingPlayer(player: Player!)

Creates a new instance that forwards all operations to player.

Public functions

addListener

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

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

fun addMediaItem(mediaItem: MediaItem!): Unit

Calls addMediaItem on the delegate.

addMediaItem

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

Calls addMediaItem on the delegate.

addMediaItems

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

Calls addMediaItems on the delegate.

addMediaItems

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

Calls addMediaItems on the delegate.

canAdvertiseSession

fun canAdvertiseSession(): Boolean

Calls canAdvertiseSession on the delegate and returns the result.

clearMediaItems

fun clearMediaItems(): Unit

Calls clearMediaItems on the delegate.

clearVideoSurface

fun clearVideoSurface(): Unit

Calls clearVideoSurface on the delegate.

clearVideoSurface

fun clearVideoSurface(surface: Surface?): Unit

Calls clearVideoSurface on the delegate.

clearVideoSurfaceHolder

fun clearVideoSurfaceHolder(surfaceHolder: SurfaceHolder?): Unit

Calls clearVideoSurfaceHolder on the delegate.

clearVideoSurfaceView

fun clearVideoSurfaceView(surfaceView: SurfaceView?): Unit

Calls clearVideoSurfaceView on the delegate.

clearVideoTextureView

fun clearVideoTextureView(textureView: TextureView?): Unit

Calls clearVideoTextureView on the delegate.

decreaseDeviceVolume

fun decreaseDeviceVolume(): Unit

decreaseDeviceVolume

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

Calls decreaseDeviceVolume on the delegate.

getApplicationLooper

fun getApplicationLooper(): Looper!

Calls getApplicationLooper on the delegate and returns the result.

getAudioAttributes

fun getAudioAttributes(): AudioAttributes!

Calls getAudioAttributes on the delegate and returns the result.

getAudioSessionId

fun getAudioSessionId(): Int

Calls getAudioSessionId on the delegate and returns the result.

getAvailableCommands

fun getAvailableCommands(): Player.Commands!

Calls getAvailableCommands on the delegate and returns the result.

getBufferedPercentage

fun getBufferedPercentage(): Int

Calls getBufferedPercentage on the delegate and returns the result.

getBufferedPosition

fun getBufferedPosition(): Long

Calls getBufferedPosition on the delegate and returns the result.

getContentBufferedPosition

fun getContentBufferedPosition(): Long

Calls getContentBufferedPosition on the delegate and returns the result.

getContentDuration

fun getContentDuration(): Long

Calls getContentDuration on the delegate and returns the result.

getContentPosition

fun getContentPosition(): Long

Calls getContentPosition on the delegate and returns the result.

getCurrentAdGroupIndex

fun getCurrentAdGroupIndex(): Int

Calls getCurrentAdGroupIndex on the delegate and returns the result.

getCurrentAdIndexInAdGroup

fun getCurrentAdIndexInAdGroup(): Int

Calls getCurrentAdIndexInAdGroup on the delegate and returns the result.

getCurrentCues

fun getCurrentCues(): CueGroup!

Calls getCurrentCues on the delegate and returns the result.

getCurrentLiveOffset

fun getCurrentLiveOffset(): Long

Calls getCurrentLiveOffset on the delegate and returns the result.

getCurrentManifest

fun getCurrentManifest(): Any?

Calls getCurrentManifest on the delegate and returns the result.

getCurrentMediaItem

fun getCurrentMediaItem(): MediaItem?

Calls getCurrentMediaItem on the delegate and returns the result.

getCurrentMediaItemIndex

fun getCurrentMediaItemIndex(): Int

Calls getCurrentMediaItemIndex on the delegate and returns the result.

getCurrentPeriodIndex

fun getCurrentPeriodIndex(): Int

Calls getCurrentPeriodIndex on the delegate and returns the result.

getCurrentPosition

fun getCurrentPosition(): Long

Calls getCurrentPosition on the delegate and returns the result.

getCurrentTimeline

fun getCurrentTimeline(): Timeline!

Calls getCurrentTimeline on the delegate and returns the result.

getCurrentTracks

fun getCurrentTracks(): Tracks!

Calls getCurrentTracks on the delegate and returns the result.

getCurrentWindowIndex

fun getCurrentWindowIndex(): Int

Calls getCurrentWindowIndex on the delegate and returns the result.

getDeviceInfo

fun getDeviceInfo(): DeviceInfo!

Calls getDeviceInfo on the delegate and returns the result.

getDeviceVolume

fun getDeviceVolume(): Int

Calls getDeviceVolume on the delegate and returns the result.

getDuration

fun getDuration(): Long

Calls getDuration on the delegate and returns the result.

getMaxSeekToPreviousPosition

fun getMaxSeekToPreviousPosition(): Long

Calls getMaxSeekToPreviousPosition on the delegate and returns the result.

getMediaItemAt

fun getMediaItemAt(index: Int): MediaItem!

Calls getMediaItemAt on the delegate and returns the result.

getMediaItemCount

fun getMediaItemCount(): Int

Calls getMediaItemCount on the delegate and returns the result.

getMediaMetadata

fun getMediaMetadata(): MediaMetadata!

Calls getMediaMetadata on the delegate and returns the result.

getNextMediaItemIndex

fun getNextMediaItemIndex(): Int

Calls getNextMediaItemIndex on the delegate and returns the result.

getNextWindowIndex

fun getNextWindowIndex(): Int

Calls getNextWindowIndex on the delegate and returns the result.

getPlayWhenReady

fun getPlayWhenReady(): Boolean

Calls getPlayWhenReady on the delegate and returns the result.

getPlaybackParameters

fun getPlaybackParameters(): PlaybackParameters!

Calls getPlaybackParameters on the delegate and returns the result.

getPlaybackState

fun getPlaybackState(): Int

Calls getPlaybackState on the delegate and returns the result.

getPlaybackSuppressionReason

fun getPlaybackSuppressionReason(): Int

Calls getPlaybackSuppressionReason on the delegate and returns the result.

getPlayerError

fun getPlayerError(): PlaybackException?

Calls getPlayerError on the delegate and returns the result.

getPlaylistMetadata

fun getPlaylistMetadata(): MediaMetadata!

Calls getPlaylistMetadata on the delegate and returns the result.

getPreviousMediaItemIndex

fun getPreviousMediaItemIndex(): Int

Calls getPreviousMediaItemIndex on the delegate and returns the result.

getPreviousWindowIndex

fun getPreviousWindowIndex(): Int

Calls getPreviousWindowIndex on the delegate and returns the result.

getRepeatMode

fun getRepeatMode(): Int

Calls getRepeatMode on the delegate and returns the result.

getSeekBackIncrement

fun getSeekBackIncrement(): Long

Calls getSeekBackIncrement on the delegate and returns the result.

getSeekForwardIncrement

fun getSeekForwardIncrement(): Long

Calls getSeekForwardIncrement on the delegate and returns the result.

getShuffleModeEnabled

fun getShuffleModeEnabled(): Boolean

Calls getShuffleModeEnabled on the delegate and returns the result.

getSurfaceSize

fun getSurfaceSize(): Size!

Calls getSurfaceSize on the delegate and returns the result.

getTotalBufferedDuration

fun getTotalBufferedDuration(): Long

Calls getTotalBufferedDuration on the delegate and returns the result.

getTrackSelectionParameters

fun getTrackSelectionParameters(): TrackSelectionParameters!

Calls getTrackSelectionParameters on the delegate and returns the result.

getVideoSize

fun getVideoSize(): VideoSize!

Calls getVideoSize on the delegate and returns the result.

getVolume

fun getVolume(): Float

Calls getVolume on the delegate and returns the result.

getWrappedPlayer

fun getWrappedPlayer(): Player!

Returns the Player to which operations are forwarded.

hasNextMediaItem

fun hasNextMediaItem(): Boolean

Calls hasNextMediaItem on the delegate and returns the result.

hasPreviousMediaItem

fun hasPreviousMediaItem(): Boolean

Calls hasPreviousMediaItem on the delegate and returns the result.

increaseDeviceVolume

fun increaseDeviceVolume(): Unit

increaseDeviceVolume

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

Calls increaseDeviceVolume on the delegate.

isCommandAvailable

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

Calls isCommandAvailable on the delegate and returns the result.

isCurrentMediaItemDynamic

fun isCurrentMediaItemDynamic(): Boolean

Calls isCurrentMediaItemDynamic on the delegate and returns the result.

isCurrentMediaItemLive

fun isCurrentMediaItemLive(): Boolean

Calls isCurrentMediaItemLive on the delegate and returns the result.

isCurrentMediaItemSeekable

fun isCurrentMediaItemSeekable(): Boolean

Calls isCurrentMediaItemSeekable on the delegate and returns the result.

isCurrentWindowDynamic

fun isCurrentWindowDynamic(): Boolean

Calls isCurrentWindowDynamic on the delegate and returns the result.

isCurrentWindowLive

fun isCurrentWindowLive(): Boolean

Calls isCurrentWindowLive on the delegate and returns the result.

isCurrentWindowSeekable

fun isCurrentWindowSeekable(): Boolean

Calls isCurrentWindowSeekable on the delegate and returns the result.

isDeviceMuted

fun isDeviceMuted(): Boolean

Calls isDeviceMuted on the delegate and returns the result.

isLoading

fun isLoading(): Boolean

Calls isLoading on the delegate and returns the result.

isPlaying

fun isPlaying(): Boolean

Calls isPlaying on the delegate and returns the result.

isPlayingAd

fun isPlayingAd(): Boolean

Calls isPlayingAd on the delegate and returns the result.

moveMediaItem

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

Calls moveMediaItem on the delegate.

moveMediaItems

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

Calls moveMediaItems on the delegate.

mute

fun mute(): Unit

Calls mute on the delegate.

pause

fun pause(): Unit

Calls pause on the delegate.

play

fun play(): Unit

Calls play on the delegate.

prepare

fun prepare(): Unit

Calls prepare on the delegate.

release

fun release(): Unit

Calls release on the delegate.

removeListener

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

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

fun removeMediaItem(index: Int): Unit

Calls removeMediaItem on the delegate.

removeMediaItems

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

Calls removeMediaItems on the delegate.

replaceMediaItem

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

Calls replaceMediaItem on the delegate.

replaceMediaItems

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

Calls replaceMediaItems on the delegate.

seekBack

fun seekBack(): Unit

Calls seekBack on the delegate.

seekForward

fun seekForward(): Unit

Calls seekForward on the delegate.

seekTo

fun seekTo(positionMs: Long): Unit

Calls seekTo on the delegate.

seekTo

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

Calls seekTo on the delegate.

seekToDefaultPosition

fun seekToDefaultPosition(): Unit

Calls seekToDefaultPosition on the delegate.

seekToDefaultPosition

fun seekToDefaultPosition(mediaItemIndex: Int): Unit

Calls seekToDefaultPosition on the delegate.

seekToNext

fun seekToNext(): Unit

Calls seekToNext on the delegate.

seekToNextMediaItem

fun seekToNextMediaItem(): Unit

Calls seekToNextMediaItem on the delegate.

seekToPrevious

fun seekToPrevious(): Unit

Calls seekToPrevious on the delegate.

seekToPreviousMediaItem

fun seekToPreviousMediaItem(): Unit

Calls seekToPreviousMediaItem on the delegate.

setAudioAttributes

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

Calls setAudioAttributes on the delegate.

setDeviceMuted

fun setDeviceMuted(muted: Boolean): Unit

setDeviceMuted

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

Calls setDeviceMuted on the delegate.

setDeviceVolume

fun setDeviceVolume(volume: Int): Unit

setDeviceVolume

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

Calls setDeviceVolume on the delegate.

setMediaItem

fun setMediaItem(mediaItem: MediaItem!): Unit

Calls setMediaItem on the delegate.

setMediaItem

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

Calls setMediaItem on the delegate.

setMediaItem

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

Calls setMediaItem on the delegate.

setMediaItems

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

Calls setMediaItems on the delegate.

setMediaItems

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

Calls setMediaItems ()} on the delegate.

setMediaItems

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

Calls setMediaItems on the delegate.

setPlayWhenReady

fun setPlayWhenReady(playWhenReady: Boolean): Unit

Calls setPlayWhenReady on the delegate.

setPlaybackParameters

fun setPlaybackParameters(playbackParameters: PlaybackParameters!): Unit

Calls setPlaybackParameters on the delegate.

setPlaybackSpeed

fun setPlaybackSpeed(speed: Float): Unit

Calls setPlaybackSpeed on the delegate.

setPlaylistMetadata

fun setPlaylistMetadata(mediaMetadata: MediaMetadata!): Unit

Calls setPlaylistMetadata on the delegate.

setRepeatMode

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

Calls setRepeatMode on the delegate.

setShuffleModeEnabled

fun setShuffleModeEnabled(shuffleModeEnabled: Boolean): Unit

Calls setShuffleModeEnabled on the delegate.

setTrackSelectionParameters

fun setTrackSelectionParameters(parameters: TrackSelectionParameters!): Unit

Calls setTrackSelectionParameters on the delegate.

setVideoSurface

fun setVideoSurface(surface: Surface?): Unit

Calls setVideoSurface on the delegate.

setVideoSurfaceHolder

fun setVideoSurfaceHolder(surfaceHolder: SurfaceHolder?): Unit

Calls setVideoSurfaceHolder on the delegate.

setVideoSurfaceView

fun setVideoSurfaceView(surfaceView: SurfaceView?): Unit

Calls setVideoSurfaceView on the delegate.

setVideoTextureView

fun setVideoTextureView(textureView: TextureView?): Unit

Calls setVideoTextureView on the delegate.

setVolume

fun setVolume(volume: Float): Unit

Calls setVolume on the delegate.

stop

fun stop(): Unit

Calls stop on the delegate.

unmute

fun unmute(): Unit

Calls unmute on the delegate.