Interface Player
-
- All Known Subinterfaces:
ExoPlayer
- All Known Implementing Classes:
BasePlayer
,CastPlayer
,SimpleExoPlayer
,StubExoPlayer
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.This interface includes some convenience methods that can be implemented by calling other methods in the interface.
BasePlayer
implements these convenience methods so inheritingBasePlayer
is recommended when implementing the interface so that only the minimal set of required methods can be implemented.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 callinggetCurrentTimeline()
. - They can provide a
TrackGroupArray
defining the currently available tracks, which can be obtained by callinggetCurrentTrackGroups()
. - They can provide a
TrackSelectionArray
defining which of the currently available tracks are selected to be rendered. This can be obtained by callinggetCurrentTrackSelections()
}.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Player.Command
Commands that can be executed on aPlayer
.static class
Player.Commands
A set ofcommands
.static interface
Player.DiscontinuityReason
Reasons for position discontinuities.static interface
Player.EventFlags
Events that can be reported viaPlayer.EventListener.onEvents(Player, Events)
.static interface
Player.EventListener
Deprecated.UsePlayer.Listener
.static class
Player.Events
A set ofPlayer.EventFlags
.static interface
Player.Listener
Listener of all changes in the Player.static interface
Player.MediaItemTransitionReason
Reasons for media item transitions.static interface
Player.PlaybackSuppressionReason
Reason why playback is suppressed even thoughgetPlayWhenReady()
istrue
.static interface
Player.PlayWhenReadyChangeReason
Reasons forplayWhenReady
changes.static class
Player.PositionInfo
Position info describing a playback position involved in a discontinuity.static interface
Player.RepeatMode
Repeat modes for playback.static interface
Player.State
Playback state.static interface
Player.TimelineChangeReason
Reasons for timeline changes.
-
Field Summary
Fields Modifier and Type Field Description static int
COMMAND_ADJUST_DEVICE_VOLUME
Command to increase and decrease the device volume and mute it.static int
COMMAND_CHANGE_MEDIA_ITEMS
Command to change theMediaItems
in the playlist.static int
COMMAND_GET_AUDIO_ATTRIBUTES
Command to get the player currentAudioAttributes
.static int
COMMAND_GET_CURRENT_MEDIA_ITEM
Command to get theMediaItem
of the current window.static int
COMMAND_GET_DEVICE_VOLUME
Command to get the device volume and whether it is muted.static int
COMMAND_GET_MEDIA_ITEMS
Command to get the current timeline and itsMediaItems
.static int
COMMAND_GET_MEDIA_ITEMS_METADATA
Command to get theMediaItems
metadata.static int
COMMAND_GET_TEXT
Command to get the text that should currently be displayed by the player.static int
COMMAND_GET_VOLUME
Command to get the player volume.static int
COMMAND_PLAY_PAUSE
Command to start, pause or resume playback.static int
COMMAND_PREPARE_STOP
Command to prepare the player, stop playback or release the player.static int
COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM
Command to seek anywhere into the current window.static int
COMMAND_SEEK_TO_DEFAULT_POSITION
Command to seek to the default position of the current window.static int
COMMAND_SEEK_TO_MEDIA_ITEM
Command to seek anywhere in any window.static int
COMMAND_SEEK_TO_NEXT_MEDIA_ITEM
Command to seek to the default position of the next window.static int
COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM
Command to seek to the default position of the previous window.static int
COMMAND_SET_DEVICE_VOLUME
Command to set the device volume and mute it.static int
COMMAND_SET_REPEAT_MODE
Command to set the repeat mode.static int
COMMAND_SET_SHUFFLE_MODE
Command to enable shuffling.static int
COMMAND_SET_SPEED_AND_PITCH
Command to set the playback speed and pitch.static int
COMMAND_SET_VIDEO_SURFACE
Command to set and clear the surface on which to render the video.static int
COMMAND_SET_VOLUME
Command to set the player volume.static int
DISCONTINUITY_REASON_AUTO_TRANSITION
Automatic playback transition from one period in the timeline to the next without explicit interaction by this player.static int
DISCONTINUITY_REASON_INTERNAL
Discontinuity introduced internally (e.g.static int
DISCONTINUITY_REASON_REMOVE
Discontinuity caused by the removal of the current period from theTimeline
.static int
DISCONTINUITY_REASON_SEEK
Seek within the current period or to another period by this player.static int
DISCONTINUITY_REASON_SEEK_ADJUSTMENT
Seek adjustment due to being unable to seek to the requested position or because the seek was permitted to be inexact.static int
DISCONTINUITY_REASON_SKIP
Discontinuity introduced by a skipped period (for instance a skipped ad).static int
EVENT_AVAILABLE_COMMANDS_CHANGED
isCommandAvailable(int)
changed for at least onePlayer.Command
.static int
EVENT_IS_LOADING_CHANGED
isLoading()
()} changed.static int
EVENT_IS_PLAYING_CHANGED
isPlaying()
changed.static int
EVENT_MEDIA_ITEM_TRANSITION
getCurrentMediaItem()
changed or the player started repeating the current item.static int
EVENT_MEDIA_METADATA_CHANGED
getMediaMetadata()
changed.static int
EVENT_PLAY_WHEN_READY_CHANGED
getPlayWhenReady()
changed.static int
EVENT_PLAYBACK_PARAMETERS_CHANGED
getPlaybackParameters()
changed.static int
EVENT_PLAYBACK_STATE_CHANGED
getPlaybackState()
changed.static int
EVENT_PLAYBACK_SUPPRESSION_REASON_CHANGED
getPlaybackSuppressionReason()
changed.static int
EVENT_PLAYER_ERROR
getPlayerError()
changed.static int
EVENT_POSITION_DISCONTINUITY
A position discontinuity occurred.static int
EVENT_REPEAT_MODE_CHANGED
getRepeatMode()
changed.static int
EVENT_SHUFFLE_MODE_ENABLED_CHANGED
getShuffleModeEnabled()
changed.static int
EVENT_STATIC_METADATA_CHANGED
getCurrentStaticMetadata()
changed.static int
EVENT_TIMELINE_CHANGED
getCurrentTimeline()
changed.static int
EVENT_TRACKS_CHANGED
getCurrentTrackGroups()
orgetCurrentTrackSelections()
changed.static int
MEDIA_ITEM_TRANSITION_REASON_AUTO
Playback has automatically transitioned to the next media item.static int
MEDIA_ITEM_TRANSITION_REASON_PLAYLIST_CHANGED
The current media item has changed because of a change in the playlist.static int
MEDIA_ITEM_TRANSITION_REASON_REPEAT
The media item has been repeated.static int
MEDIA_ITEM_TRANSITION_REASON_SEEK
A seek to another media item has occurred.static int
PLAY_WHEN_READY_CHANGE_REASON_AUDIO_BECOMING_NOISY
Playback has been paused to avoid becoming noisy.static int
PLAY_WHEN_READY_CHANGE_REASON_AUDIO_FOCUS_LOSS
Playback has been paused because of a loss of audio focus.static int
PLAY_WHEN_READY_CHANGE_REASON_END_OF_MEDIA_ITEM
Playback has been paused at the end of a media item.static int
PLAY_WHEN_READY_CHANGE_REASON_REMOTE
Playback has been started or paused because of a remote change.static int
PLAY_WHEN_READY_CHANGE_REASON_USER_REQUEST
Playback has been started or paused by a call tosetPlayWhenReady(boolean)
.static int
PLAYBACK_SUPPRESSION_REASON_NONE
Playback is not suppressed.static int
PLAYBACK_SUPPRESSION_REASON_TRANSIENT_AUDIO_FOCUS_LOSS
Playback is suppressed due to transient audio focus loss.static int
REPEAT_MODE_ALL
Repeats the entire timeline infinitely.static int
REPEAT_MODE_OFF
Normal playback without repetition.static int
REPEAT_MODE_ONE
Repeats the currently playing window infinitely during ongoing playback.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.static int
TIMELINE_CHANGE_REASON_PLAYLIST_CHANGED
Timeline changed as a result of a change of the playlist items or the order of the items.static int
TIMELINE_CHANGE_REASON_SOURCE_UPDATE
Timeline changed as a result of a dynamic update introduced by the played media.
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
addListener(Player.EventListener listener)
Deprecated.UseaddListener(Listener)
andremoveListener(Listener)
instead.void
addListener(Player.Listener listener)
Registers a listener to receive all events from the player.void
addMediaItem(int index, MediaItem mediaItem)
Adds a media item at the given index of the playlist.void
addMediaItem(MediaItem mediaItem)
Adds a media item to the end of the playlist.void
addMediaItems(int index, List<MediaItem> mediaItems)
Adds a list of media items at the given index of the playlist.void
addMediaItems(List<MediaItem> mediaItems)
Adds a list of media items to the end of the playlist.void
clearMediaItems()
Clears the playlist.void
clearVideoSurface()
void
clearVideoSurface(Surface surface)
Clears theSurface
onto which video is being rendered if it matches the one passed.void
clearVideoSurfaceHolder(SurfaceHolder surfaceHolder)
Clears theSurfaceHolder
that holds theSurface
onto which video is being rendered if it matches the one passed.void
clearVideoSurfaceView(SurfaceView surfaceView)
Clears theSurfaceView
onto which video is being rendered if it matches the one passed.void
clearVideoTextureView(TextureView textureView)
Clears theTextureView
onto which video is being rendered if it matches the one passed.void
decreaseDeviceVolume()
Decreases the volume of the device.Looper
getApplicationLooper()
Returns theLooper
associated with the application thread that's used to access the player and on which player events are received.AudioAttributes
getAudioAttributes()
Returns the attributes for audio playback.Player.Commands
getAvailableCommands()
Returns the player's currently availablePlayer.Commands
.int
getBufferedPercentage()
Returns an estimate of the percentage in the current content window or ad up to which data is buffered, or 0 if no estimate is available.long
getBufferedPosition()
Returns an estimate of the position in the current content window or ad up to which data is buffered, in milliseconds.long
getContentBufferedPosition()
IfisPlayingAd()
returnstrue
, returns an estimate of the content position in the current content window up to which data is buffered, in milliseconds.long
getContentDuration()
IfisPlayingAd()
returnstrue
, returns the duration of the current content window in milliseconds, orC.TIME_UNSET
if the duration is not known.long
getContentPosition()
IfisPlayingAd()
returnstrue
, returns the content position that will be played once all ads in the ad group have finished playing, in milliseconds.int
getCurrentAdGroupIndex()
IfisPlayingAd()
returns true, returns the index of the ad group in the period currently being played.int
getCurrentAdIndexInAdGroup()
IfisPlayingAd()
returns true, returns the index of the ad in its ad group.List<Cue>
getCurrentCues()
Returns the currentCues
.long
getCurrentLiveOffset()
Returns the offset of the current playback position from the live edge in milliseconds, orC.TIME_UNSET
if the current windowisn't live
or the offset is unknown.Object
getCurrentManifest()
Returns the current manifest.MediaItem
getCurrentMediaItem()
Returns the media item of the current window in the timeline.int
getCurrentPeriodIndex()
Returns the index of the period currently being played.long
getCurrentPosition()
Returns the playback position in the current content window or ad, in milliseconds, or the prospective position in milliseconds if thecurrent timeline
is empty.List<Metadata>
getCurrentStaticMetadata()
Returns the current static metadata for the track selections.Object
getCurrentTag()
Deprecated.UsegetCurrentMediaItem()
andMediaItem.PlaybackProperties.tag
instead.Timeline
getCurrentTimeline()
Returns the currentTimeline
.TrackGroupArray
getCurrentTrackGroups()
Returns the available track groups.TrackSelectionArray
getCurrentTrackSelections()
Returns the current track selections.int
getCurrentWindowIndex()
Returns the index of the currentwindow
in thetimeline
, or the prospective window index if thecurrent timeline
is empty.DeviceInfo
getDeviceInfo()
Gets the device information.int
getDeviceVolume()
Gets the current volume of the device.long
getDuration()
Returns the duration of the current content window or ad in milliseconds, orC.TIME_UNSET
if the duration is not known.MediaItem
getMediaItemAt(int index)
Returns theMediaItem
at the given index.int
getMediaItemCount()
Returns the number ofmedia items
in the playlist.MediaMetadata
getMediaMetadata()
Returns the current combinedMediaMetadata
, orMediaMetadata.EMPTY
if not supported.int
getNextWindowIndex()
Returns the index of the window that will be played ifnext()
is called, which may depend on the current repeat mode and whether shuffle mode is enabled.ExoPlaybackException
getPlaybackError()
Deprecated.UsegetPlayerError()
instead.PlaybackParameters
getPlaybackParameters()
Returns the currently active playback parameters.int
getPlaybackState()
Returns the currentplayback state
of the player.int
getPlaybackSuppressionReason()
Returns the reason why playback is suppressed even thoughgetPlayWhenReady()
istrue
, orPLAYBACK_SUPPRESSION_REASON_NONE
if playback is not suppressed.ExoPlaybackException
getPlayerError()
Returns the error that caused playback to fail.boolean
getPlayWhenReady()
Whether playback will proceed whengetPlaybackState()
==STATE_READY
.int
getPreviousWindowIndex()
Returns the index of the window that will be played ifprevious()
is called, which may depend on the current repeat mode and whether shuffle mode is enabled.int
getRepeatMode()
Returns the currentPlayer.RepeatMode
used for playback.boolean
getShuffleModeEnabled()
Returns whether shuffling of windows is enabled.long
getTotalBufferedDuration()
Returns an estimate of the total buffered duration from the current position, in milliseconds.VideoSize
getVideoSize()
Gets the size of the video.float
getVolume()
Returns the audio volume, with 0 being silence and 1 being unity gain (signal unchanged).boolean
hasNext()
Returns whether a next window exists, which may depend on the current repeat mode and whether shuffle mode is enabled.boolean
hasPrevious()
Returns whether a previous window exists, which may depend on the current repeat mode and whether shuffle mode is enabled.void
increaseDeviceVolume()
Increases the volume of the device.boolean
isCommandAvailable(int command)
Returns whether the providedPlayer.Command
is available.boolean
isCurrentWindowDynamic()
Returns whether the current window is dynamic, orfalse
if theTimeline
is empty.boolean
isCurrentWindowLive()
Returns whether the current window is live, orfalse
if theTimeline
is empty.boolean
isCurrentWindowSeekable()
Returns whether the current window is seekable, orfalse
if theTimeline
is empty.boolean
isDeviceMuted()
Gets whether the device is muted or not.boolean
isLoading()
Whether the player is currently loading the source.boolean
isPlaying()
Returns whether the player is playing, i.e.boolean
isPlayingAd()
Returns whether the player is currently playing an ad.void
moveMediaItem(int currentIndex, int newIndex)
Moves the media item at the current index to the new index.void
moveMediaItems(int fromIndex, int toIndex, int newIndex)
Moves the media item range to the new index.void
next()
Seeks to the default position of the next window, which may depend on the current repeat mode and whether shuffle mode is enabled.void
pause()
Pauses playback.void
play()
Resumes playback as soon asgetPlaybackState()
==STATE_READY
.void
prepare()
Prepares the player.void
previous()
Seeks to the default position of the previous window, which may depend on the current repeat mode and whether shuffle mode is enabled.void
release()
Releases the player.void
removeListener(Player.EventListener listener)
Deprecated.UseaddListener(Listener)
andremoveListener(Listener)
instead.void
removeListener(Player.Listener listener)
Unregister a listener registered throughaddListener(Listener)
.void
removeMediaItem(int index)
Removes the media item at the given index of the playlist.void
removeMediaItems(int fromIndex, int toIndex)
Removes a range of media items from the playlist.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
setDeviceMuted(boolean muted)
Sets the mute state of the device.void
setDeviceVolume(int volume)
Sets the volume of the device.void
setMediaItem(MediaItem mediaItem)
Clears the playlist, adds the specifiedMediaItem
and resets the position to the default position.void
setMediaItem(MediaItem mediaItem, boolean resetPosition)
Clears the playlist and adds the specifiedMediaItem
.void
setMediaItem(MediaItem mediaItem, long startPositionMs)
Clears the playlist and adds the specifiedMediaItem
.void
setMediaItems(List<MediaItem> mediaItems)
Clears the playlist, adds the specifiedMediaItems
and resets the position to the default position.void
setMediaItems(List<MediaItem> mediaItems, boolean resetPosition)
Clears the playlist and adds the specifiedMediaItems
.void
setMediaItems(List<MediaItem> mediaItems, int startWindowIndex, long startPositionMs)
Clears the playlist and adds the specifiedMediaItems
.void
setPlaybackParameters(PlaybackParameters playbackParameters)
Attempts to set the playback parameters.void
setPlaybackSpeed(float speed)
Changes the rate at which playback occurs.void
setPlayWhenReady(boolean playWhenReady)
Sets whether playback should proceed whengetPlaybackState()
==STATE_READY
.void
setRepeatMode(int repeatMode)
Sets thePlayer.RepeatMode
to be used for playback.void
setShuffleModeEnabled(boolean shuffleModeEnabled)
Sets whether shuffling of windows is enabled.void
setVideoSurface(Surface surface)
Sets theSurface
onto which video will be rendered.void
setVideoSurfaceHolder(SurfaceHolder surfaceHolder)
Sets theSurfaceHolder
that holds theSurface
onto which video will be rendered.void
setVideoSurfaceView(SurfaceView surfaceView)
Sets theSurfaceView
onto which video will be rendered.void
setVideoTextureView(TextureView textureView)
Sets theTextureView
onto which video will be rendered.void
setVolume(float audioVolume)
Sets the audio volume, with 0 being silence and 1 being unity gain (signal unchanged).void
stop()
Stops playback without resetting the player.void
stop(boolean reset)
Deprecated.
-
-
-
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 ifgetPlayWhenReady()
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
-
PLAY_WHEN_READY_CHANGE_REASON_USER_REQUEST
static final int PLAY_WHEN_READY_CHANGE_REASON_USER_REQUEST
Playback has been started or paused by a call tosetPlayWhenReady(boolean)
.- See Also:
- Constant Field Values
-
PLAY_WHEN_READY_CHANGE_REASON_AUDIO_FOCUS_LOSS
static final int PLAY_WHEN_READY_CHANGE_REASON_AUDIO_FOCUS_LOSS
Playback has been paused because of a loss of audio focus.- See Also:
- Constant Field Values
-
PLAY_WHEN_READY_CHANGE_REASON_AUDIO_BECOMING_NOISY
static final int PLAY_WHEN_READY_CHANGE_REASON_AUDIO_BECOMING_NOISY
Playback has been paused to avoid becoming noisy.- See Also:
- Constant Field Values
-
PLAY_WHEN_READY_CHANGE_REASON_REMOTE
static final int PLAY_WHEN_READY_CHANGE_REASON_REMOTE
Playback has been started or paused because of a remote change.- See Also:
- Constant Field Values
-
PLAY_WHEN_READY_CHANGE_REASON_END_OF_MEDIA_ITEM
static final int PLAY_WHEN_READY_CHANGE_REASON_END_OF_MEDIA_ITEM
Playback has been paused at the end of a media item.- See Also:
- Constant Field Values
-
PLAYBACK_SUPPRESSION_REASON_NONE
static final int PLAYBACK_SUPPRESSION_REASON_NONE
Playback is not suppressed.- See Also:
- Constant Field Values
-
PLAYBACK_SUPPRESSION_REASON_TRANSIENT_AUDIO_FOCUS_LOSS
static final int PLAYBACK_SUPPRESSION_REASON_TRANSIENT_AUDIO_FOCUS_LOSS
Playback is suppressed due to transient audio focus loss.- See Also:
- Constant Field Values
-
REPEAT_MODE_OFF
static final int REPEAT_MODE_OFF
Normal playback without repetition. "Previous" and "Next" actions move to the previous and next windows respectively, and do nothing when there is no previous or next window to move to.- See Also:
- Constant Field Values
-
REPEAT_MODE_ONE
static final int REPEAT_MODE_ONE
Repeats the currently playing window infinitely during ongoing playback. "Previous" and "Next" actions behave as they do inREPEAT_MODE_OFF
, moving to the previous and next windows respectively, and doing nothing when there is no previous or next window to move to.- See Also:
- Constant Field Values
-
REPEAT_MODE_ALL
static final int REPEAT_MODE_ALL
Repeats the entire timeline infinitely. "Previous" and "Next" actions behave as they do inREPEAT_MODE_OFF
, but with looping at the ends so that "Previous" when playing the first window will move to the last window, and "Next" when playing the last window will move to the first window.- See Also:
- Constant Field Values
-
DISCONTINUITY_REASON_AUTO_TRANSITION
static final int DISCONTINUITY_REASON_AUTO_TRANSITION
Automatic playback transition from one period in the timeline to the next without explicit interaction by this player. The period index may be the same as it was before the discontinuity in case the current period is repeated.This reason also indicates an automatic transition from the content period to an inserted ad period or vice versa.
- See Also:
- Constant Field Values
-
DISCONTINUITY_REASON_SEEK
static final int DISCONTINUITY_REASON_SEEK
Seek within the current period or to another period by this player.- See Also:
- Constant Field Values
-
DISCONTINUITY_REASON_SEEK_ADJUSTMENT
static final int DISCONTINUITY_REASON_SEEK_ADJUSTMENT
Seek adjustment due to being unable to seek to the requested position or because the seek was permitted to be inexact.- See Also:
- Constant Field Values
-
DISCONTINUITY_REASON_SKIP
static final int DISCONTINUITY_REASON_SKIP
Discontinuity introduced by a skipped period (for instance a skipped ad).- See Also:
- Constant Field Values
-
DISCONTINUITY_REASON_REMOVE
static final int DISCONTINUITY_REASON_REMOVE
Discontinuity caused by the removal of the current period from theTimeline
.- See Also:
- Constant Field Values
-
DISCONTINUITY_REASON_INTERNAL
static final int DISCONTINUITY_REASON_INTERNAL
Discontinuity introduced internally (e.g. by the source).- See Also:
- Constant Field Values
-
TIMELINE_CHANGE_REASON_PLAYLIST_CHANGED
static final int TIMELINE_CHANGE_REASON_PLAYLIST_CHANGED
Timeline changed as a result of a change of the playlist items or the order of the items.- See Also:
- Constant Field Values
-
TIMELINE_CHANGE_REASON_SOURCE_UPDATE
static final int TIMELINE_CHANGE_REASON_SOURCE_UPDATE
Timeline changed as a result of a dynamic update introduced by the played media.- See Also:
- Constant Field Values
-
MEDIA_ITEM_TRANSITION_REASON_REPEAT
static final int MEDIA_ITEM_TRANSITION_REASON_REPEAT
The media item has been repeated.- See Also:
- Constant Field Values
-
MEDIA_ITEM_TRANSITION_REASON_AUTO
static final int MEDIA_ITEM_TRANSITION_REASON_AUTO
Playback has automatically transitioned to the next media item.- See Also:
- Constant Field Values
-
MEDIA_ITEM_TRANSITION_REASON_SEEK
static final int MEDIA_ITEM_TRANSITION_REASON_SEEK
A seek to another media item has occurred.- See Also:
- Constant Field Values
-
MEDIA_ITEM_TRANSITION_REASON_PLAYLIST_CHANGED
static final int MEDIA_ITEM_TRANSITION_REASON_PLAYLIST_CHANGED
The current media item has changed because of a change in the playlist. This can either be if the media item previously being played has been removed, or when the playlist becomes non-empty after being empty.- See Also:
- Constant Field Values
-
EVENT_TIMELINE_CHANGED
static final int EVENT_TIMELINE_CHANGED
getCurrentTimeline()
changed.- See Also:
- Constant Field Values
-
EVENT_MEDIA_ITEM_TRANSITION
static final int EVENT_MEDIA_ITEM_TRANSITION
getCurrentMediaItem()
changed or the player started repeating the current item.- See Also:
- Constant Field Values
-
EVENT_TRACKS_CHANGED
static final int EVENT_TRACKS_CHANGED
getCurrentTrackGroups()
orgetCurrentTrackSelections()
changed.- See Also:
- Constant Field Values
-
EVENT_STATIC_METADATA_CHANGED
static final int EVENT_STATIC_METADATA_CHANGED
getCurrentStaticMetadata()
changed.- See Also:
- Constant Field Values
-
EVENT_IS_LOADING_CHANGED
static final int EVENT_IS_LOADING_CHANGED
isLoading()
()} changed.- See Also:
- Constant Field Values
-
EVENT_PLAYBACK_STATE_CHANGED
static final int EVENT_PLAYBACK_STATE_CHANGED
getPlaybackState()
changed.- See Also:
- Constant Field Values
-
EVENT_PLAY_WHEN_READY_CHANGED
static final int EVENT_PLAY_WHEN_READY_CHANGED
getPlayWhenReady()
changed.- See Also:
- Constant Field Values
-
EVENT_PLAYBACK_SUPPRESSION_REASON_CHANGED
static final int EVENT_PLAYBACK_SUPPRESSION_REASON_CHANGED
getPlaybackSuppressionReason()
changed.- See Also:
- Constant Field Values
-
EVENT_IS_PLAYING_CHANGED
static final int EVENT_IS_PLAYING_CHANGED
isPlaying()
changed.- See Also:
- Constant Field Values
-
EVENT_REPEAT_MODE_CHANGED
static final int EVENT_REPEAT_MODE_CHANGED
getRepeatMode()
changed.- See Also:
- Constant Field Values
-
EVENT_SHUFFLE_MODE_ENABLED_CHANGED
static final int EVENT_SHUFFLE_MODE_ENABLED_CHANGED
getShuffleModeEnabled()
changed.- See Also:
- Constant Field Values
-
EVENT_PLAYER_ERROR
static final int EVENT_PLAYER_ERROR
getPlayerError()
changed.- See Also:
- Constant Field Values
-
EVENT_POSITION_DISCONTINUITY
static final int EVENT_POSITION_DISCONTINUITY
A position discontinuity occurred. SeePlayer.EventListener.onPositionDiscontinuity(PositionInfo, PositionInfo, int)
.- See Also:
- Constant Field Values
-
EVENT_PLAYBACK_PARAMETERS_CHANGED
static final int EVENT_PLAYBACK_PARAMETERS_CHANGED
getPlaybackParameters()
changed.- See Also:
- Constant Field Values
-
EVENT_AVAILABLE_COMMANDS_CHANGED
static final int EVENT_AVAILABLE_COMMANDS_CHANGED
isCommandAvailable(int)
changed for at least onePlayer.Command
.- See Also:
- Constant Field Values
-
EVENT_MEDIA_METADATA_CHANGED
static final int EVENT_MEDIA_METADATA_CHANGED
getMediaMetadata()
changed.- See Also:
- Constant Field Values
-
COMMAND_PLAY_PAUSE
static final int COMMAND_PLAY_PAUSE
Command to start, pause or resume playback.- See Also:
- Constant Field Values
-
COMMAND_PREPARE_STOP
static final int COMMAND_PREPARE_STOP
Command to prepare the player, stop playback or release the player.- See Also:
- Constant Field Values
-
COMMAND_SEEK_TO_DEFAULT_POSITION
static final int COMMAND_SEEK_TO_DEFAULT_POSITION
Command to seek to the default position of the current window.- See Also:
- Constant Field Values
-
COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM
static final int COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM
Command to seek anywhere into the current window.- See Also:
- Constant Field Values
-
COMMAND_SEEK_TO_NEXT_MEDIA_ITEM
static final int COMMAND_SEEK_TO_NEXT_MEDIA_ITEM
Command to seek to the default position of the next window.- See Also:
- Constant Field Values
-
COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM
static final int COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM
Command to seek to the default position of the previous window.- See Also:
- Constant Field Values
-
COMMAND_SEEK_TO_MEDIA_ITEM
static final int COMMAND_SEEK_TO_MEDIA_ITEM
Command to seek anywhere in any window.- See Also:
- Constant Field Values
-
COMMAND_SET_SPEED_AND_PITCH
static final int COMMAND_SET_SPEED_AND_PITCH
Command to set the playback speed and pitch.- See Also:
- Constant Field Values
-
COMMAND_SET_SHUFFLE_MODE
static final int COMMAND_SET_SHUFFLE_MODE
Command to enable shuffling.- See Also:
- Constant Field Values
-
COMMAND_SET_REPEAT_MODE
static final int COMMAND_SET_REPEAT_MODE
Command to set the repeat mode.- See Also:
- Constant Field Values
-
COMMAND_GET_CURRENT_MEDIA_ITEM
static final int COMMAND_GET_CURRENT_MEDIA_ITEM
Command to get theMediaItem
of the current window.- See Also:
- Constant Field Values
-
COMMAND_GET_MEDIA_ITEMS
static final int COMMAND_GET_MEDIA_ITEMS
Command to get the current timeline and itsMediaItems
.- See Also:
- Constant Field Values
-
COMMAND_GET_MEDIA_ITEMS_METADATA
static final int COMMAND_GET_MEDIA_ITEMS_METADATA
Command to get theMediaItems
metadata.- See Also:
- Constant Field Values
-
COMMAND_CHANGE_MEDIA_ITEMS
static final int COMMAND_CHANGE_MEDIA_ITEMS
Command to change theMediaItems
in the playlist.- See Also:
- Constant Field Values
-
COMMAND_GET_AUDIO_ATTRIBUTES
static final int COMMAND_GET_AUDIO_ATTRIBUTES
Command to get the player currentAudioAttributes
.- See Also:
- Constant Field Values
-
COMMAND_GET_VOLUME
static final int COMMAND_GET_VOLUME
Command to get the player volume.- See Also:
- Constant Field Values
-
COMMAND_GET_DEVICE_VOLUME
static final int COMMAND_GET_DEVICE_VOLUME
Command to get the device volume and whether it is muted.- See Also:
- Constant Field Values
-
COMMAND_SET_VOLUME
static final int COMMAND_SET_VOLUME
Command to set the player volume.- See Also:
- Constant Field Values
-
COMMAND_SET_DEVICE_VOLUME
static final int COMMAND_SET_DEVICE_VOLUME
Command to set the device volume and mute it.- See Also:
- Constant Field Values
-
COMMAND_ADJUST_DEVICE_VOLUME
static final int COMMAND_ADJUST_DEVICE_VOLUME
Command to increase and decrease the device volume and mute it.- See Also:
- Constant Field Values
-
COMMAND_SET_VIDEO_SURFACE
static final int COMMAND_SET_VIDEO_SURFACE
Command to set and clear the surface on which to render the video.- See Also:
- Constant Field Values
-
COMMAND_GET_TEXT
static final int COMMAND_GET_TEXT
Command to get the text that should currently be displayed by the player.- See Also:
- Constant Field Values
-
-
Method Detail
-
getApplicationLooper
Looper getApplicationLooper()
Returns theLooper
associated with the application thread that's used to access the player and on which player events are received.
-
addListener
@Deprecated void addListener(Player.EventListener listener)
Deprecated.UseaddListener(Listener)
andremoveListener(Listener)
instead.Registers 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 aLooper
, then the listener will be called on the main thread.- Parameters:
listener
- The listener to register.
-
addListener
void addListener(Player.Listener listener)
Registers a listener to receive all events from the player.- Parameters:
listener
- The listener to register.
-
removeListener
@Deprecated void removeListener(Player.EventListener listener)
Deprecated.UseaddListener(Listener)
andremoveListener(Listener)
instead.Unregister a listener registered throughaddListener(EventListener)
. The listener will no longer receive events from the player.- Parameters:
listener
- The listener to unregister.
-
removeListener
void removeListener(Player.Listener listener)
Unregister a listener registered throughaddListener(Listener)
. The listener will no longer receive events.- Parameters:
listener
- The listener to unregister.
-
setMediaItems
void setMediaItems(List<MediaItem> mediaItems)
Clears the playlist, adds the specifiedMediaItems
and resets the position to the default position.- Parameters:
mediaItems
- The newMediaItems
.
-
setMediaItems
void setMediaItems(List<MediaItem> mediaItems, boolean resetPosition)
Clears the playlist and adds the specifiedMediaItems
.- Parameters:
mediaItems
- The newMediaItems
.resetPosition
- Whether the playback position should be reset to the default position in the firstTimeline.Window
. If false, playback will start from the position defined bygetCurrentWindowIndex()
andgetCurrentPosition()
.
-
setMediaItems
void setMediaItems(List<MediaItem> mediaItems, int startWindowIndex, long startPositionMs)
Clears the playlist and adds the specifiedMediaItems
.- Parameters:
mediaItems
- The newMediaItems
.startWindowIndex
- The window index to start playback from. IfC.INDEX_UNSET
is passed, the current position is not reset.startPositionMs
- The position in milliseconds to start playback from. IfC.TIME_UNSET
is passed, the default position of the given window is used. In any case, ifstartWindowIndex
is set toC.INDEX_UNSET
, this parameter is ignored and the position is not reset at all.- Throws:
IllegalSeekPositionException
- If the providedstartWindowIndex
is not within the bounds of the list of media items.
-
setMediaItem
void setMediaItem(MediaItem mediaItem)
Clears the playlist, adds the specifiedMediaItem
and resets the position to the default position.- Parameters:
mediaItem
- The newMediaItem
.
-
setMediaItem
void setMediaItem(MediaItem mediaItem, long startPositionMs)
Clears the playlist and adds the specifiedMediaItem
.- Parameters:
mediaItem
- The newMediaItem
.startPositionMs
- The position in milliseconds to start playback from.
-
setMediaItem
void setMediaItem(MediaItem mediaItem, boolean resetPosition)
Clears the playlist and adds the specifiedMediaItem
.- Parameters:
mediaItem
- The newMediaItem
.resetPosition
- Whether the playback position should be reset to the default position. If false, playback will start from the position defined bygetCurrentWindowIndex()
andgetCurrentPosition()
.
-
addMediaItem
void addMediaItem(MediaItem mediaItem)
Adds a media item to the end of the playlist.- Parameters:
mediaItem
- TheMediaItem
to add.
-
addMediaItem
void addMediaItem(int index, MediaItem mediaItem)
Adds a media item at the given index of the playlist.- Parameters:
index
- The index at which to add the media item. If the index is larger than the size of the playlist, the media item is added to the end of the playlist.mediaItem
- TheMediaItem
to add.
-
addMediaItems
void addMediaItems(List<MediaItem> mediaItems)
Adds a list of media items to the end of the playlist.- Parameters:
mediaItems
- TheMediaItems
to add.
-
addMediaItems
void addMediaItems(int index, List<MediaItem> mediaItems)
Adds a list of media items at the given index of the playlist.- Parameters:
index
- The index at which to add the media items. If the index is larger than the size of the playlist, the media items are added to the end of the playlist.mediaItems
- TheMediaItems
to add.
-
moveMediaItem
void moveMediaItem(int currentIndex, int newIndex)
Moves the media item at the current index to the new index.- Parameters:
currentIndex
- The current index of the media item to move.newIndex
- The new index of the media item. If the new index is larger than the size of the playlist the item is moved to the end of the playlist.
-
moveMediaItems
void moveMediaItems(int fromIndex, int toIndex, int newIndex)
Moves the media item range to the new index.- Parameters:
fromIndex
- The start of the range to move.toIndex
- The first item not to be included in the range (exclusive).newIndex
- The new index of the first media item of the range. If the new index is larger than the size of the remaining playlist after removing the range, the range is moved to the end of the playlist.
-
removeMediaItem
void removeMediaItem(int index)
Removes the media item at the given index of the playlist.- Parameters:
index
- The index at which to remove the media item.
-
removeMediaItems
void removeMediaItems(int fromIndex, int toIndex)
Removes a range of media items from the playlist.- Parameters:
fromIndex
- The index at which to start removing media items.toIndex
- The index of the first item to be kept (exclusive). If the index is larger than the size of the playlist, media items to the end of the playlist are removed.
-
clearMediaItems
void clearMediaItems()
Clears the playlist.
-
isCommandAvailable
boolean isCommandAvailable(@Command int command)
Returns whether the providedPlayer.Command
is available.This method does not execute the command.
Executing a command that is not available (for example, calling
next()
ifCOMMAND_SEEK_TO_NEXT_MEDIA_ITEM
is unavailable) will neither throw an exception nor generate agetPlayerError()
player error}.COMMAND_SEEK_TO_NEXT_MEDIA_ITEM
andCOMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM
are unavailable if there is no suchMediaItem
.- Parameters:
command
- APlayer.Command
.- Returns:
- Whether the
Player.Command
is available. - See Also:
Player.EventListener.onAvailableCommandsChanged(Commands)
-
getAvailableCommands
Player.Commands getAvailableCommands()
Returns the player's currently availablePlayer.Commands
.The returned
Player.Commands
are not updated when available commands change. UsePlayer.EventListener.onAvailableCommandsChanged(Commands)
to get an update when the available commands change.Executing a command that is not available (for example, calling
next()
ifCOMMAND_SEEK_TO_NEXT_MEDIA_ITEM
is unavailable) will neither throw an exception nor generate agetPlayerError()
player error}.COMMAND_SEEK_TO_NEXT_MEDIA_ITEM
andCOMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM
are unavailable if there is no suchMediaItem
.- Returns:
- The currently available
Player.Commands
. - See Also:
Player.EventListener.onAvailableCommandsChanged(com.google.android.exoplayer2.Player.Commands)
-
prepare
void prepare()
Prepares the player.
-
getPlaybackState
@State int getPlaybackState()
Returns the currentplayback state
of the player.- Returns:
- The current
playback state
. - See Also:
Player.EventListener.onPlaybackStateChanged(int)
-
getPlaybackSuppressionReason
@PlaybackSuppressionReason int getPlaybackSuppressionReason()
Returns the reason why playback is suppressed even thoughgetPlayWhenReady()
istrue
, orPLAYBACK_SUPPRESSION_REASON_NONE
if playback is not suppressed.- Returns:
- The current
playback suppression reason
. - See Also:
Player.EventListener.onPlaybackSuppressionReasonChanged(int)
-
isPlaying
boolean isPlaying()
Returns whether the player is playing, i.e.getCurrentPosition()
is advancing.If
false
, then at least one of the following is true:- The
playback state
is notready
. - There is no
intention to play
. - Playback is
suppressed for other reasons
.
- Returns:
- Whether the player is playing.
- See Also:
Player.EventListener.onIsPlayingChanged(boolean)
- The
-
getPlayerError
@Nullable ExoPlaybackException getPlayerError()
Returns the error that caused playback to fail. This is the same error that will have been reported viaPlayer.EventListener.onPlayerError(ExoPlaybackException)
at the time of failure. It can be queried using this method until the player is re-prepared.Note that this method will always return
null
ifgetPlaybackState()
is notSTATE_IDLE
.- Returns:
- The error, or
null
. - See Also:
Player.EventListener.onPlayerError(ExoPlaybackException)
-
getPlaybackError
@Deprecated @Nullable ExoPlaybackException getPlaybackError()
Deprecated.UsegetPlayerError()
instead.
-
play
void play()
Resumes playback as soon asgetPlaybackState()
==STATE_READY
. Equivalent tosetPlayWhenReady(true)
.
-
pause
void pause()
Pauses playback. Equivalent tosetPlayWhenReady(false)
.
-
setPlayWhenReady
void setPlayWhenReady(boolean playWhenReady)
Sets whether playback should proceed whengetPlaybackState()
==STATE_READY
.If the player is already in the ready state then this method pauses and resumes playback.
- Parameters:
playWhenReady
- Whether playback should proceed when ready.
-
getPlayWhenReady
boolean getPlayWhenReady()
Whether playback will proceed whengetPlaybackState()
==STATE_READY
.- Returns:
- Whether playback will proceed when ready.
- See Also:
Player.EventListener.onPlayWhenReadyChanged(boolean, int)
-
setRepeatMode
void setRepeatMode(@RepeatMode int repeatMode)
Sets thePlayer.RepeatMode
to be used for playback.- Parameters:
repeatMode
- The repeat mode.
-
getRepeatMode
@RepeatMode int getRepeatMode()
Returns the currentPlayer.RepeatMode
used for playback.- Returns:
- The current repeat mode.
- See Also:
Player.EventListener.onRepeatModeChanged(int)
-
setShuffleModeEnabled
void setShuffleModeEnabled(boolean shuffleModeEnabled)
Sets whether shuffling of windows is enabled.- Parameters:
shuffleModeEnabled
- Whether shuffling is enabled.
-
getShuffleModeEnabled
boolean getShuffleModeEnabled()
Returns whether shuffling of windows is enabled.
-
isLoading
boolean isLoading()
Whether the player is currently loading the source.- Returns:
- Whether the player is currently loading the source.
- See Also:
Player.EventListener.onIsLoadingChanged(boolean)
-
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.- Throws:
IllegalSeekPositionException
- If the player has a non-empty timeline and the providedwindowIndex
is not within the bounds of the current timeline.
-
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, orC.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, orC.TIME_UNSET
to seek to the window's default position.- Throws:
IllegalSeekPositionException
- If the player has a non-empty timeline and the providedwindowIndex
is not within the bounds of the current timeline.
-
hasPrevious
boolean hasPrevious()
Returns whether a previous window exists, which may depend on the current repeat mode and whether shuffle mode is enabled.Note: When the repeat mode is
REPEAT_MODE_ONE
, this method behaves the same as when the current repeat mode isREPEAT_MODE_OFF
. SeeREPEAT_MODE_ONE
for more details.
-
previous
void previous()
Seeks to the default position of the previous window, which may depend on the current repeat mode and whether shuffle mode is enabled. Does nothing ifhasPrevious()
isfalse
.Note: When the repeat mode is
REPEAT_MODE_ONE
, this method behaves the same as when the current repeat mode isREPEAT_MODE_OFF
. SeeREPEAT_MODE_ONE
for more details.
-
hasNext
boolean hasNext()
Returns whether a next window exists, which may depend on the current repeat mode and whether shuffle mode is enabled.Note: When the repeat mode is
REPEAT_MODE_ONE
, this method behaves the same as when the current repeat mode isREPEAT_MODE_OFF
. SeeREPEAT_MODE_ONE
for more details.
-
next
void next()
Seeks to the default position of the next window, which may depend on the current repeat mode and whether shuffle mode is enabled. Does nothing ifhasNext()
isfalse
.Note: When the repeat mode is
REPEAT_MODE_ONE
, this method behaves the same as when the current repeat mode isREPEAT_MODE_OFF
. SeeREPEAT_MODE_ONE
for more details.
-
setPlaybackParameters
void setPlaybackParameters(PlaybackParameters playbackParameters)
Attempts to set the playback parameters. PassingPlaybackParameters.DEFAULT
resets the player to the 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.- Parameters:
playbackParameters
- The playback parameters.
-
setPlaybackSpeed
void setPlaybackSpeed(float speed)
Changes the rate at which playback occurs. The pitch is not changed.This is equivalent to
setPlaybackParameters(getPlaybackParameters().withSpeed(speed))
.- Parameters:
speed
- The linear factor by which playback will be sped up. Must be higher than 0. 1 is normal speed, 2 is twice as fast, 0.5 is half normal speed...
-
getPlaybackParameters
PlaybackParameters getPlaybackParameters()
Returns the currently active playback parameters.
-
stop
void stop()
Stops playback without resetting the player. Usepause()
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, andrelease()
must still be called on the player if it's no longer required.Calling this method does not clear the playlist, reset the playback position or the playback error.
-
stop
@Deprecated void stop(boolean reset)
Deprecated.Usestop()
andclearMediaItems()
(ifreset
is true) or juststop()
(ifreset
is false). Any player error will be cleared whenre-preparing
the player.
-
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.
-
getCurrentTrackGroups
TrackGroupArray getCurrentTrackGroups()
Returns the available track groups.
-
getCurrentTrackSelections
TrackSelectionArray getCurrentTrackSelections()
Returns the current track selections.A concrete implementation may include null elements if it has a fixed number of renderer components, wishes to report a TrackSelection for each of them, and has one or more renderer components that is not assigned any selected tracks.
-
getCurrentStaticMetadata
List<Metadata> getCurrentStaticMetadata()
Returns the current static metadata for the track selections.The returned
metadataList
is an immutable list ofMetadata
instances, where the elements correspond to thecurrent track selections
, or an empty list if there are no track selections or the selected tracks contain no static metadata.This metadata is considered static in that it comes from the tracks' declared Formats, rather than being timed (or dynamic) metadata, which is represented within a metadata track.
-
getMediaMetadata
MediaMetadata getMediaMetadata()
Returns the current combinedMediaMetadata
, orMediaMetadata.EMPTY
if not supported.This
MediaMetadata
is a combination of theMediaItem.mediaMetadata
and the static and dynamic metadata sourced fromPlayer.EventListener.onStaticMetadataChanged(List)
andMetadataOutput.onMetadata(Metadata)
.
-
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 currentTimeline
. 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 currentwindow
in thetimeline
, or the prospective window index if thecurrent timeline
is empty.
-
getNextWindowIndex
int getNextWindowIndex()
Returns the index of the window that will be played ifnext()
is called, which may depend on the current repeat mode and whether shuffle mode is enabled. ReturnsC.INDEX_UNSET
ifhasNext()
isfalse
.Note: When the repeat mode is
REPEAT_MODE_ONE
, this method behaves the same as when the current repeat mode isREPEAT_MODE_OFF
. SeeREPEAT_MODE_ONE
for more details.
-
getPreviousWindowIndex
int getPreviousWindowIndex()
Returns the index of the window that will be played ifprevious()
is called, which may depend on the current repeat mode and whether shuffle mode is enabled. ReturnsC.INDEX_UNSET
ifhasPrevious()
isfalse
.Note: When the repeat mode is
REPEAT_MODE_ONE
, this method behaves the same as when the current repeat mode isREPEAT_MODE_OFF
. SeeREPEAT_MODE_ONE
for more details.
-
getCurrentTag
@Deprecated @Nullable Object getCurrentTag()
Deprecated.UsegetCurrentMediaItem()
andMediaItem.PlaybackProperties.tag
instead.
-
getCurrentMediaItem
@Nullable MediaItem getCurrentMediaItem()
Returns the media item of the current window in the timeline. May be null if the timeline is empty.
-
getMediaItemCount
int getMediaItemCount()
Returns the number ofmedia items
in the playlist.
-
getDuration
long getDuration()
Returns the duration of the current content window or ad in milliseconds, orC.TIME_UNSET
if the duration is not known.
-
getCurrentPosition
long getCurrentPosition()
Returns the playback position in the current content window or ad, in milliseconds, or the prospective position in milliseconds if thecurrent timeline
is empty.
-
getBufferedPosition
long getBufferedPosition()
Returns an estimate of the position in the current content window or ad up to which data is buffered, in milliseconds.
-
getBufferedPercentage
int getBufferedPercentage()
Returns an estimate of the percentage in the current content window or ad up to which data is buffered, or 0 if no estimate is available.
-
getTotalBufferedDuration
long getTotalBufferedDuration()
Returns an estimate of the total buffered duration from the current position, in milliseconds. This includes pre-buffered data for subsequent ads and windows.
-
isCurrentWindowDynamic
boolean isCurrentWindowDynamic()
Returns whether the current window is dynamic, orfalse
if theTimeline
is empty.- See Also:
Timeline.Window.isDynamic
-
isCurrentWindowLive
boolean isCurrentWindowLive()
Returns whether the current window is live, orfalse
if theTimeline
is empty.- See Also:
Timeline.Window.isLive()
-
getCurrentLiveOffset
long getCurrentLiveOffset()
Returns the offset of the current playback position from the live edge in milliseconds, orC.TIME_UNSET
if the current windowisn't live
or the offset is unknown.The offset is calculated as
currentTime - playbackPosition
, so should usually be positive.Note that this offset may rely on an accurate local time, so this method may return an incorrect value if the difference between system clock and server clock is unknown.
-
isCurrentWindowSeekable
boolean isCurrentWindowSeekable()
Returns whether the current window is seekable, orfalse
if theTimeline
is empty.- See Also:
Timeline.Window.isSeekable
-
isPlayingAd
boolean isPlayingAd()
Returns whether the player is currently playing an ad.
-
getCurrentAdGroupIndex
int getCurrentAdGroupIndex()
IfisPlayingAd()
returns true, returns the index of the ad group in the period currently being played. ReturnsC.INDEX_UNSET
otherwise.
-
getCurrentAdIndexInAdGroup
int getCurrentAdIndexInAdGroup()
IfisPlayingAd()
returns true, returns the index of the ad in its ad group. ReturnsC.INDEX_UNSET
otherwise.
-
getContentDuration
long getContentDuration()
IfisPlayingAd()
returnstrue
, returns the duration of the current content window in milliseconds, orC.TIME_UNSET
if the duration is not known. If there is no ad playing, the returned duration is the same as that returned bygetDuration()
.
-
getContentPosition
long getContentPosition()
IfisPlayingAd()
returnstrue
, 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 bygetCurrentPosition()
.
-
getContentBufferedPosition
long getContentBufferedPosition()
IfisPlayingAd()
returnstrue
, returns an estimate of the content position in the current content window up to which data is buffered, in milliseconds. If there is no ad playing, the returned position is the same as that returned bygetBufferedPosition()
.
-
getAudioAttributes
AudioAttributes getAudioAttributes()
Returns the attributes for audio playback.
-
setVolume
void setVolume(float audioVolume)
Sets the audio volume, with 0 being silence and 1 being unity gain (signal unchanged).- Parameters:
audioVolume
- Linear output gain to apply to all audio channels.
-
getVolume
float getVolume()
Returns the audio volume, with 0 being silence and 1 being unity gain (signal unchanged).- Returns:
- The linear gain applied to all audio channels.
-
clearVideoSurface
void clearVideoSurface()
-
clearVideoSurface
void clearVideoSurface(@Nullable Surface surface)
Clears theSurface
onto which video is being rendered if it matches the one passed. Else does nothing.- Parameters:
surface
- The surface to clear.
-
setVideoSurface
void setVideoSurface(@Nullable Surface surface)
Sets theSurface
onto which video will be rendered. The caller is responsible for tracking the lifecycle of the surface, and must clear the surface by callingsetVideoSurface(null)
if the surface is destroyed.If the surface is held by a
SurfaceView
,TextureView
orSurfaceHolder
then it's recommended to usesetVideoSurfaceView(SurfaceView)
,setVideoTextureView(TextureView)
orsetVideoSurfaceHolder(SurfaceHolder)
rather than this method, since passing the holder allows the player to track the lifecycle of the surface automatically.- Parameters:
surface
- TheSurface
.
-
setVideoSurfaceHolder
void setVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)
Sets theSurfaceHolder
that holds theSurface
onto which video will be rendered. The player will track the lifecycle of the surface automatically.- Parameters:
surfaceHolder
- The surface holder.
-
clearVideoSurfaceHolder
void clearVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)
Clears theSurfaceHolder
that holds theSurface
onto which video is being rendered if it matches the one passed. Else does nothing.- Parameters:
surfaceHolder
- The surface holder to clear.
-
setVideoSurfaceView
void setVideoSurfaceView(@Nullable SurfaceView surfaceView)
Sets theSurfaceView
onto which video will be rendered. The player will track the lifecycle of the surface automatically.- Parameters:
surfaceView
- The surface view.
-
clearVideoSurfaceView
void clearVideoSurfaceView(@Nullable SurfaceView surfaceView)
Clears theSurfaceView
onto which video is being rendered if it matches the one passed. Else does nothing.- Parameters:
surfaceView
- The texture view to clear.
-
setVideoTextureView
void setVideoTextureView(@Nullable TextureView textureView)
Sets theTextureView
onto which video will be rendered. The player will track the lifecycle of the surface automatically.- Parameters:
textureView
- The texture view.
-
clearVideoTextureView
void clearVideoTextureView(@Nullable TextureView textureView)
Clears theTextureView
onto which video is being rendered if it matches the one passed. Else does nothing.- Parameters:
textureView
- The texture view to clear.
-
getVideoSize
VideoSize getVideoSize()
Gets the size of the video.The video's width and height are
0
if there is no video or its size has not been determined yet.
-
getDeviceInfo
DeviceInfo getDeviceInfo()
Gets the device information.
-
getDeviceVolume
int getDeviceVolume()
Gets the current volume of the device.For devices with
local playback
, the volume returned by this method varies according to the currentstream type
. The stream type is determined byAudioAttributes.usage
which can be converted to stream type withUtil.getStreamTypeForAudioUsage(int)
.For devices with
remote playback
, the volume of the remote device is returned.
-
isDeviceMuted
boolean isDeviceMuted()
Gets whether the device is muted or not.
-
setDeviceVolume
void setDeviceVolume(int volume)
Sets the volume of the device.- Parameters:
volume
- The volume to set.
-
increaseDeviceVolume
void increaseDeviceVolume()
Increases the volume of the device.
-
decreaseDeviceVolume
void decreaseDeviceVolume()
Decreases the volume of the device.
-
setDeviceMuted
void setDeviceMuted(boolean muted)
Sets the mute state of the device.
-
-