Player (ExoPlayer library)

All Known Subinterfaces:

ExoPlayer

All Known Implementing Classes:

SimpleExoPlayer
```
public interface Player
```
A media player interface defining traditional high-level functionality, such as the ability to play, pause, seek and query properties of the currently playing media.
Some important properties of media players that implement this interface are:
- They can provide a Timeline representing the structure of the media being played, which can be obtained by calling getCurrentTimeline().
- They can provide a TrackGroupArray defining the currently available tracks, which can be obtained by calling getCurrentTrackGroups().
- They contain a number of renderers, each of which is able to render tracks of a single type (e.g. audio, video or text). The number of renderers and their respective track types can be obtained by calling getRendererCount() and getRendererType(int).
- They can provide a TrackSelectionArray defining which of the currently available tracks are selected to be rendered by each renderer. This can be obtained by calling getCurrentTrackSelections()}.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Player.EventListener` Listener of changes in player state.
`static interface`	`Player.RepeatMode` Repeat modes for playback.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`REPEAT_MODE_ALL` "Repeat All" mode to repeat the entire timeline infinitely.
`static int`	`REPEAT_MODE_OFF` Normal playback without repetition.
`static int`	`REPEAT_MODE_ONE` "Repeat One" mode to repeat the currently playing window infinitely.
`static int`	`STATE_BUFFERING` The player is not able to immediately play from its current position.
`static int`	`STATE_ENDED` The player has finished playing the media.
`static int`	`STATE_IDLE` The player does not have any media to play.
`static int`	`STATE_READY` The player is able to immediately play from its current position.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addListener(Player.EventListener listener)` Register a listener to receive events from the player.
`int`	`getBufferedPercentage()` Returns an estimate of the percentage in the current window up to which data is buffered, or 0 if no estimate is available.
`long`	`getBufferedPosition()` Returns an estimate of the position in the current window up to which data is buffered, in milliseconds.
`long`	`getContentPosition()` If `isPlayingAd()` returns `true`, returns the content position that will be played once all ads in the ad group have finished playing, in milliseconds.
`int`	`getCurrentAdGroupIndex()` If `isPlayingAd()` returns true, returns the index of the ad group in the period currently being played.
`int`	`getCurrentAdIndexInAdGroup()` If `isPlayingAd()` returns true, returns the index of the ad in its ad group.
`Object`	`getCurrentManifest()` Returns the current manifest.
`int`	`getCurrentPeriodIndex()` Returns the index of the period currently being played.
`long`	`getCurrentPosition()` Returns the playback position in the current window, in milliseconds.
`Timeline`	`getCurrentTimeline()` Returns the current `Timeline`.
`TrackGroupArray`	`getCurrentTrackGroups()` Returns the available track groups.
`TrackSelectionArray`	`getCurrentTrackSelections()` Returns the current track selections for each renderer.
`int`	`getCurrentWindowIndex()` Returns the index of the window currently being played.
`long`	`getDuration()` Returns the duration of the current window in milliseconds, or `C.TIME_UNSET` if the duration is not known.
`PlaybackParameters`	`getPlaybackParameters()` Returns the currently active playback parameters.
`int`	`getPlaybackState()` Returns the current state of the player.
`boolean`	`getPlayWhenReady()` Whether playback will proceed when `getPlaybackState()` == `STATE_READY`.
`int`	`getRendererCount()` Returns the number of renderers.
`int`	`getRendererType(int index)` Returns the track type that the renderer at a given index handles.
`int`	`getRepeatMode()` Returns the current `Player.RepeatMode` used for playback.
`boolean`	`isCurrentWindowDynamic()` Returns whether the current window is dynamic, or `false` if the `Timeline` is empty.
`boolean`	`isCurrentWindowSeekable()` Returns whether the current window is seekable, or `false` if the `Timeline` is empty.
`boolean`	`isLoading()` Whether the player is currently loading the source.
`boolean`	`isPlayingAd()` Returns whether the player is currently playing an ad.
`void`	`release()` Releases the player.
`void`	`removeListener(Player.EventListener listener)` Unregister a listener.
`void`	`seekTo(int windowIndex, long positionMs)` Seeks to a position specified in milliseconds in the specified window.
`void`	`seekTo(long positionMs)` Seeks to a position specified in milliseconds in the current window.
`void`	`seekToDefaultPosition()` Seeks to the default position associated with the current window.
`void`	`seekToDefaultPosition(int windowIndex)` Seeks to the default position associated with the specified window.
`void`	`setPlaybackParameters(PlaybackParameters playbackParameters)` Attempts to set the playback parameters.
`void`	`setPlayWhenReady(boolean playWhenReady)` Sets whether playback should proceed when `getPlaybackState()` == `STATE_READY`.
`void`	`setRepeatMode(int repeatMode)` Sets the `Player.RepeatMode` to be used for playback.
`void`	`stop()` Stops playback.

- Field Detail
  - STATE_IDLE
```
static final int STATE_IDLE
```
    The player does not have any media to play.
    
    See Also:
    
    Constant Field Values
  - STATE_BUFFERING
```
static final int STATE_BUFFERING
```
    The player is not able to immediately play from its current position. This state typically occurs when more data needs to be loaded.
    
    See Also:
    
    Constant Field Values
  - STATE_READY
```
static final int STATE_READY
```
    The player is able to immediately play from its current position. The player will be playing if getPlayWhenReady() is true, and paused otherwise.
    
    See Also:
    
    Constant Field Values
  - STATE_ENDED
```
static final int STATE_ENDED
```
    The player has finished playing the media.
    
    See Also:
    
    Constant Field Values
  - REPEAT_MODE_OFF
```
static final int REPEAT_MODE_OFF
```
    Normal playback without repetition.
    
    See Also:
    
    Constant Field Values
  - REPEAT_MODE_ONE
```
static final int REPEAT_MODE_ONE
```
    "Repeat One" mode to repeat the currently playing window infinitely.
    
    See Also:
    
    Constant Field Values
  - REPEAT_MODE_ALL
```
static final int REPEAT_MODE_ALL
```
    "Repeat All" mode to repeat the entire timeline infinitely.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - addListener
```
void addListener(Player.EventListener listener)
```
    Register a listener to receive events from the player. The listener's methods will be called on the thread that was used to construct the player. However, if the thread used to construct the player does not have a Looper, then the listener will be called on the main thread.
    
    Parameters:
    
    listener - The listener to register.
  - removeListener
```
void removeListener(Player.EventListener listener)
```
    Unregister a listener. The listener will no longer receive events from the player.
    
    Parameters:
    
    listener - The listener to unregister.
  - getPlaybackState
```
int getPlaybackState()
```
    Returns the current state of the player.
    
    Returns:
    
    One of the STATE constants defined in this interface.
  - setPlayWhenReady
```
void setPlayWhenReady(boolean playWhenReady)
```
    Sets whether playback should proceed when getPlaybackState() == STATE_READY.
    If the player is already in the ready state then this method can be used to pause and resume playback.
    
    Parameters:
    
    playWhenReady - Whether playback should proceed when ready.
  - getPlayWhenReady
```
boolean getPlayWhenReady()
```
    Whether playback will proceed when getPlaybackState() == STATE_READY.
    
    Returns:
    
    Whether playback will proceed when ready.
  - setRepeatMode
```
void setRepeatMode(int repeatMode)
```
    Sets the Player.RepeatMode to be used for playback.
    
    Parameters:
    
    repeatMode - A repeat mode.
  - getRepeatMode
```
int getRepeatMode()
```
    Returns the current Player.RepeatMode used for playback.
    
    Returns:
    
    The current repeat mode.
  - isLoading
```
boolean isLoading()
```
    Whether the player is currently loading the source.
    
    Returns:
    
    Whether the player is currently loading the source.
  - seekToDefaultPosition
```
void seekToDefaultPosition()
```
    Seeks to the default position associated with the current window. The position can depend on the type of media being played. For live streams it will typically be the live edge of the window. For other streams it will typically be the start of the window.
  - seekToDefaultPosition
```
void seekToDefaultPosition(int windowIndex)
```
    Seeks to the default position associated with the specified window. The position can depend on the type of media being played. For live streams it will typically be the live edge of the window. For other streams it will typically be the start of the window.
    
    Parameters:
    
    windowIndex - The index of the window whose associated default position should be seeked to.
  - seekTo
```
void seekTo(long positionMs)
```
    Seeks to a position specified in milliseconds in the current window.
    
    Parameters:
    
    positionMs - The seek position in the current window, or C.TIME_UNSET to seek to the window's default position.
  - seekTo
```
void seekTo(int windowIndex,
            long positionMs)
```
    Seeks to a position specified in milliseconds in the specified window.
    
    Parameters:
    
    windowIndex - The index of the window.
    
    positionMs - The seek position in the specified window, or C.TIME_UNSET to seek to the window's default position.
  - setPlaybackParameters
```
void setPlaybackParameters(@Nullable
                           PlaybackParameters playbackParameters)
```
    Attempts to set the playback parameters. Passing null sets the parameters to the default, PlaybackParameters.DEFAULT, which means there is no speed or pitch adjustment.
    Playback parameters changes may cause the player to buffer. Player.EventListener.onPlaybackParametersChanged(PlaybackParameters) will be called whenever the currently active playback parameters change. When that listener is called, the parameters passed to it may not match playbackParameters. For example, the chosen speed or pitch may be out of range, in which case they are constrained to a set of permitted values. If it is not possible to change the playback parameters, the listener will not be invoked.
    
    Parameters:
    
    playbackParameters - The playback parameters, or null to use the defaults.
  - getPlaybackParameters
```
PlaybackParameters getPlaybackParameters()
```
    Returns the currently active playback parameters.
    
    See Also:
    
    Player.EventListener.onPlaybackParametersChanged(PlaybackParameters)
  - stop
```
void stop()
```
    Stops playback. Use setPlayWhenReady(false) rather than this method if the intention is to pause playback.
    Calling this method will cause the playback state to transition to STATE_IDLE. The player instance can still be used, and release() must still be called on the player if it's no longer required.
    Calling this method does not reset the playback position.
  - release
```
void release()
```
    Releases the player. This method must be called when the player is no longer required. The player must not be used after calling this method.
  - getRendererCount
```
int getRendererCount()
```
    Returns the number of renderers.
  - getRendererType
```
int getRendererType(int index)
```
    Returns the track type that the renderer at a given index handles.
    
    Parameters:
    
    index - The index of the renderer.
    
    Returns:
    
    One of the TRACK_TYPE_* constants defined in C.
    
    See Also:
    
    Renderer.getTrackType()
  - getCurrentTrackGroups
```
TrackGroupArray getCurrentTrackGroups()
```
    Returns the available track groups.
  - getCurrentTrackSelections
```
TrackSelectionArray getCurrentTrackSelections()
```
    Returns the current track selections for each renderer.
  - getCurrentManifest
```
@Nullable
Object getCurrentManifest()
```
    Returns the current manifest. The type depends on the type of media being played. May be null.
  - getCurrentTimeline
```
Timeline getCurrentTimeline()
```
    Returns the current Timeline. Never null, but may be empty.
  - getCurrentPeriodIndex
```
int getCurrentPeriodIndex()
```
    Returns the index of the period currently being played.
  - getCurrentWindowIndex
```
int getCurrentWindowIndex()
```
    Returns the index of the window currently being played.
  - getDuration
```
long getDuration()
```
    Returns the duration of the current window in milliseconds, or C.TIME_UNSET if the duration is not known.
  - getCurrentPosition
```
long getCurrentPosition()
```
    Returns the playback position in the current window, in milliseconds.
  - getBufferedPosition
```
long getBufferedPosition()
```
    Returns an estimate of the position in the current window up to which data is buffered, in milliseconds.
  - getBufferedPercentage
```
int getBufferedPercentage()
```
    Returns an estimate of the percentage in the current window up to which data is buffered, or 0 if no estimate is available.
  - isCurrentWindowDynamic
```
boolean isCurrentWindowDynamic()
```
    Returns whether the current window is dynamic, or false if the Timeline is empty.
    
    See Also:
    
    Timeline.Window.isDynamic
  - isCurrentWindowSeekable
```
boolean isCurrentWindowSeekable()
```
    Returns whether the current window is seekable, or false if the Timeline is empty.
    
    See Also:
    
    Timeline.Window.isSeekable
  - isPlayingAd
```
boolean isPlayingAd()
```
    Returns whether the player is currently playing an ad.
  - getCurrentAdGroupIndex
```
int getCurrentAdGroupIndex()
```
    If isPlayingAd() returns true, returns the index of the ad group in the period currently being played. Returns C.INDEX_UNSET otherwise.
  - getCurrentAdIndexInAdGroup
```
int getCurrentAdIndexInAdGroup()
```
    If isPlayingAd() returns true, returns the index of the ad in its ad group. Returns C.INDEX_UNSET otherwise.
  - getContentPosition
```
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. If there is no ad playing, the returned position is the same as that returned by getCurrentPosition().

Interface Player

Nested Class Summary

Field Summary

Method Summary

Field Detail

STATE_IDLE

STATE_BUFFERING

STATE_READY

STATE_ENDED

REPEAT_MODE_OFF

REPEAT_MODE_ONE

REPEAT_MODE_ALL

Method Detail

addListener

removeListener

getPlaybackState

setPlayWhenReady

getPlayWhenReady

setRepeatMode

getRepeatMode

isLoading

seekToDefaultPosition

seekToDefaultPosition

seekTo

seekTo

setPlaybackParameters

getPlaybackParameters

stop

release

getRendererCount

getRendererType

getCurrentTrackGroups

getCurrentTrackSelections

getCurrentManifest

getCurrentTimeline

getCurrentPeriodIndex

getCurrentWindowIndex

getDuration

getCurrentPosition

getBufferedPosition

getBufferedPercentage

isCurrentWindowDynamic

isCurrentWindowSeekable

isPlayingAd

getCurrentAdGroupIndex

getCurrentAdIndexInAdGroup

getContentPosition