Class SimpleBasePlayer
- java.lang.Object
-
- com.google.android.exoplayer2.BasePlayer
-
- com.google.android.exoplayer2.SimpleBasePlayer
-
- All Implemented Interfaces:
Player
- Direct Known Subclasses:
LegacyMediaPlayerWrapper
public abstract class SimpleBasePlayer extends BasePlayer
A base implementation forPlayerthat reduces the number of methods to implement to a minimum.Implementation notes:
- Subclasses must override
getState()to populate the current player state on request. - The
SimpleBasePlayer.Stateshould set the available commands to indicate whichPlayermethods are supported. - All setter-like player methods (for example,
setPlayWhenReady(boolean)) forward to overridable methods (for example,handleSetPlayWhenReady(boolean)) that can be used to handle these requests. These methods return aListenableFutureto indicate when the request has been handled and is fully reflected in the values returned fromgetState(). This class will automatically request a state update once the request is done. If the state changes can be handled synchronously, these methods can return Guava'sFutures.immediateVoidFuture(). - Subclasses can manually trigger state updates with
invalidateState(), for example if something changes independent ofPlayermethod calls.
- The
SimpleBasePlayer.Statecan only be created with allowed combinations of state values, avoiding any invalid player states. - Only functionality that is declared as available needs to be implemented. Other methods are automatically ignored.
- Listener handling and informing listeners of state changes is handled automatically.
- The base class provides a framework for asynchronous handling of method calls. It changes the visible playback state immediately to the most likely outcome to ensure the user-visible state changes look like synchronous operations. The state is then updated again once the asynchronous method calls have been fully handled.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static classSimpleBasePlayer.StateAn immutable state description of the player.-
Nested classes/interfaces inherited from interface com.google.android.exoplayer2.Player
Player.Command, Player.Commands, Player.DiscontinuityReason, Player.Event, Player.Events, Player.Listener, Player.MediaItemTransitionReason, Player.PlaybackSuppressionReason, Player.PlayWhenReadyChangeReason, Player.PositionInfo, Player.RepeatMode, Player.TimelineChangeReason
-
-
Field Summary
-
Fields inherited from class com.google.android.exoplayer2.BasePlayer
window
-
Fields inherited from interface com.google.android.exoplayer2.Player
COMMAND_ADJUST_DEVICE_VOLUME, COMMAND_CHANGE_MEDIA_ITEMS, COMMAND_GET_AUDIO_ATTRIBUTES, COMMAND_GET_CURRENT_MEDIA_ITEM, COMMAND_GET_DEVICE_VOLUME, COMMAND_GET_MEDIA_ITEMS_METADATA, COMMAND_GET_TEXT, COMMAND_GET_TIMELINE, COMMAND_GET_TRACKS, COMMAND_GET_VOLUME, COMMAND_INVALID, COMMAND_PLAY_PAUSE, COMMAND_PREPARE, COMMAND_SEEK_BACK, COMMAND_SEEK_FORWARD, COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM, COMMAND_SEEK_IN_CURRENT_WINDOW, COMMAND_SEEK_TO_DEFAULT_POSITION, COMMAND_SEEK_TO_MEDIA_ITEM, COMMAND_SEEK_TO_NEXT, COMMAND_SEEK_TO_NEXT_MEDIA_ITEM, COMMAND_SEEK_TO_NEXT_WINDOW, COMMAND_SEEK_TO_PREVIOUS, COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM, COMMAND_SEEK_TO_PREVIOUS_WINDOW, COMMAND_SEEK_TO_WINDOW, COMMAND_SET_DEVICE_VOLUME, COMMAND_SET_MEDIA_ITEM, COMMAND_SET_MEDIA_ITEMS_METADATA, COMMAND_SET_REPEAT_MODE, COMMAND_SET_SHUFFLE_MODE, COMMAND_SET_SPEED_AND_PITCH, COMMAND_SET_TRACK_SELECTION_PARAMETERS, COMMAND_SET_VIDEO_SURFACE, COMMAND_SET_VOLUME, COMMAND_STOP, DISCONTINUITY_REASON_AUTO_TRANSITION, DISCONTINUITY_REASON_INTERNAL, DISCONTINUITY_REASON_REMOVE, DISCONTINUITY_REASON_SEEK, DISCONTINUITY_REASON_SEEK_ADJUSTMENT, DISCONTINUITY_REASON_SKIP, EVENT_AUDIO_ATTRIBUTES_CHANGED, EVENT_AUDIO_SESSION_ID, EVENT_AVAILABLE_COMMANDS_CHANGED, EVENT_CUES, EVENT_DEVICE_INFO_CHANGED, EVENT_DEVICE_VOLUME_CHANGED, EVENT_IS_LOADING_CHANGED, EVENT_IS_PLAYING_CHANGED, EVENT_MAX_SEEK_TO_PREVIOUS_POSITION_CHANGED, EVENT_MEDIA_ITEM_TRANSITION, EVENT_MEDIA_METADATA_CHANGED, EVENT_METADATA, EVENT_PLAY_WHEN_READY_CHANGED, EVENT_PLAYBACK_PARAMETERS_CHANGED, EVENT_PLAYBACK_STATE_CHANGED, EVENT_PLAYBACK_SUPPRESSION_REASON_CHANGED, EVENT_PLAYER_ERROR, EVENT_PLAYLIST_METADATA_CHANGED, EVENT_POSITION_DISCONTINUITY, EVENT_RENDERED_FIRST_FRAME, EVENT_REPEAT_MODE_CHANGED, EVENT_SEEK_BACK_INCREMENT_CHANGED, EVENT_SEEK_FORWARD_INCREMENT_CHANGED, EVENT_SHUFFLE_MODE_ENABLED_CHANGED, EVENT_SKIP_SILENCE_ENABLED_CHANGED, EVENT_SURFACE_SIZE_CHANGED, EVENT_TIMELINE_CHANGED, EVENT_TRACK_SELECTION_PARAMETERS_CHANGED, EVENT_TRACKS_CHANGED, EVENT_VIDEO_SIZE_CHANGED, EVENT_VOLUME_CHANGED, MEDIA_ITEM_TRANSITION_REASON_AUTO, MEDIA_ITEM_TRANSITION_REASON_PLAYLIST_CHANGED, MEDIA_ITEM_TRANSITION_REASON_REPEAT, MEDIA_ITEM_TRANSITION_REASON_SEEK, PLAY_WHEN_READY_CHANGE_REASON_AUDIO_BECOMING_NOISY, PLAY_WHEN_READY_CHANGE_REASON_AUDIO_FOCUS_LOSS, PLAY_WHEN_READY_CHANGE_REASON_END_OF_MEDIA_ITEM, PLAY_WHEN_READY_CHANGE_REASON_REMOTE, PLAY_WHEN_READY_CHANGE_REASON_USER_REQUEST, PLAYBACK_SUPPRESSION_REASON_NONE, PLAYBACK_SUPPRESSION_REASON_TRANSIENT_AUDIO_FOCUS_LOSS, REPEAT_MODE_ALL, REPEAT_MODE_OFF, REPEAT_MODE_ONE, STATE_BUFFERING, STATE_ENDED, STATE_IDLE, STATE_READY, TIMELINE_CHANGE_REASON_PLAYLIST_CHANGED, TIMELINE_CHANGE_REASON_SOURCE_UPDATE
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedSimpleBasePlayer(Looper applicationLooper)Creates the base class.protectedSimpleBasePlayer(Looper applicationLooper, Clock clock)Creates the base class.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidaddListener(Player.Listener listener)Registers a listener to receive all events from the player.voidaddMediaItems(int index, List<MediaItem> mediaItems)Adds a list of media items at the given index of the playlist.voidclearVideoSurface()voidclearVideoSurface(Surface surface)Clears theSurfaceonto which video is being rendered if it matches the one passed.voidclearVideoSurfaceHolder(SurfaceHolder surfaceHolder)Clears theSurfaceHolderthat holds theSurfaceonto which video is being rendered if it matches the one passed.voidclearVideoSurfaceView(SurfaceView surfaceView)Clears theSurfaceViewonto which video is being rendered if it matches the one passed.voidclearVideoTextureView(TextureView textureView)Clears theTextureViewonto which video is being rendered if it matches the one passed.voiddecreaseDeviceVolume()Decreases the volume of the device.LoopergetApplicationLooper()Returns theLooperassociated with the application thread that's used to access the player and on which player events are received.AudioAttributesgetAudioAttributes()Returns the attributes for audio playback.Player.CommandsgetAvailableCommands()Returns the player's currently availablePlayer.Commands.longgetBufferedPosition()Returns an estimate of the position in the current content or ad up to which data is buffered, in milliseconds.longgetContentBufferedPosition()IfPlayer.isPlayingAd()returnstrue, returns an estimate of the content position in the current content up to which data is buffered, in milliseconds.longgetContentPosition()IfPlayer.isPlayingAd()returnstrue, returns the content position that will be played once all ads in the ad group have finished playing, in milliseconds.intgetCurrentAdGroupIndex()IfPlayer.isPlayingAd()returns true, returns the index of the ad group in the period currently being played.intgetCurrentAdIndexInAdGroup()IfPlayer.isPlayingAd()returns true, returns the index of the ad in its ad group.CueGroupgetCurrentCues()Returns the currentCueGroup.intgetCurrentMediaItemIndex()Returns the index of the currentMediaItemin thetimeline, or the prospective index if thecurrent timelineis empty.intgetCurrentPeriodIndex()Returns the index of the period currently being played.longgetCurrentPosition()Returns the playback position in the current content or ad, in milliseconds, or the prospective position in milliseconds if thecurrent timelineis empty.TimelinegetCurrentTimeline()Returns the currentTimeline.TracksgetCurrentTracks()Returns the current tracks.DeviceInfogetDeviceInfo()Gets the device information.intgetDeviceVolume()Gets the current volume of the device.longgetDuration()Returns the duration of the current content or ad in milliseconds, orC.TIME_UNSETif the duration is not known.longgetMaxSeekToPreviousPosition()Returns the maximum position for whichPlayer.seekToPrevious()seeks to the previousMediaItem, in milliseconds.MediaMetadatagetMediaMetadata()Returns the current combinedMediaMetadata, orMediaMetadata.EMPTYif not supported.protected SimpleBasePlayer.StategetPlaceholderState(SimpleBasePlayer.State suggestedPlaceholderState)Returns the placeholder state used while a player method is handled asynchronously.PlaybackParametersgetPlaybackParameters()Returns the currently active playback parameters.intgetPlaybackState()Returns the currentplayback stateof the player.intgetPlaybackSuppressionReason()Returns the reason why playback is suppressed even thoughPlayer.getPlayWhenReady()istrue, orPlayer.PLAYBACK_SUPPRESSION_REASON_NONEif playback is not suppressed.PlaybackExceptiongetPlayerError()Returns the error that caused playback to fail.MediaMetadatagetPlaylistMetadata()Returns the playlistMediaMetadata, as set byPlayer.setPlaylistMetadata(MediaMetadata), orMediaMetadata.EMPTYif not supported.booleangetPlayWhenReady()Whether playback will proceed whenPlayer.getPlaybackState()==Player.STATE_READY.intgetRepeatMode()Returns the currentPlayer.RepeatModeused for playback.longgetSeekBackIncrement()Returns thePlayer.seekBack()increment.longgetSeekForwardIncrement()Returns thePlayer.seekForward()increment.booleangetShuffleModeEnabled()Returns whether shuffling of media items is enabled.protected abstract SimpleBasePlayer.StategetState()Returns the currentSimpleBasePlayer.Stateof the player.SizegetSurfaceSize()Gets the size of the surface on which the video is rendered.longgetTotalBufferedDuration()Returns an estimate of the total buffered duration from the current position, in milliseconds.TrackSelectionParametersgetTrackSelectionParameters()Returns the parameters constraining the track selection.VideoSizegetVideoSize()Gets the size of the video.floatgetVolume()Returns the audio volume, with 0 being silence and 1 being unity gain (signal unchanged).protected ListenableFuture<?>handleSetPlayWhenReady(boolean playWhenReady)Handles calls to setSimpleBasePlayer.State.playWhenReady.voidincreaseDeviceVolume()Increases the volume of the device.protected voidinvalidateState()Invalidates the current state.booleanisDeviceMuted()Gets whether the device is muted or not.booleanisLoading()Whether the player is currently loading the source.booleanisPlayingAd()Returns whether the player is currently playing an ad.voidmoveMediaItems(int fromIndex, int toIndex, int newIndex)Moves the media item range to the new index.voidprepare()Prepares the player.voidrelease()Releases the player.voidremoveListener(Player.Listener listener)Unregister a listener registered throughPlayer.addListener(Listener).voidremoveMediaItems(int fromIndex, int toIndex)Removes a range of media items from the playlist.voidseekTo(int mediaItemIndex, long positionMs)Seeks to a position specified in milliseconds in the specifiedMediaItem.voidsetDeviceMuted(boolean muted)Sets the mute state of the device.voidsetDeviceVolume(int volume)Sets the volume of the device.voidsetMediaItems(List<MediaItem> mediaItems, boolean resetPosition)Clears the playlist and adds the specifiedMediaItems.voidsetMediaItems(List<MediaItem> mediaItems, int startIndex, long startPositionMs)Clears the playlist and adds the specifiedMediaItems.voidsetPlaybackParameters(PlaybackParameters playbackParameters)Attempts to set the playback parameters.voidsetPlaylistMetadata(MediaMetadata mediaMetadata)Sets the playlistMediaMetadata.voidsetPlayWhenReady(boolean playWhenReady)Sets whether playback should proceed whenPlayer.getPlaybackState()==Player.STATE_READY.voidsetRepeatMode(int repeatMode)Sets thePlayer.RepeatModeto be used for playback.voidsetShuffleModeEnabled(boolean shuffleModeEnabled)Sets whether shuffling of media items is enabled.voidsetTrackSelectionParameters(TrackSelectionParameters parameters)Sets the parameters constraining the track selection.voidsetVideoSurface(Surface surface)Sets theSurfaceonto which video will be rendered.voidsetVideoSurfaceHolder(SurfaceHolder surfaceHolder)Sets theSurfaceHolderthat holds theSurfaceonto which video will be rendered.voidsetVideoSurfaceView(SurfaceView surfaceView)Sets theSurfaceViewonto which video will be rendered.voidsetVideoTextureView(TextureView textureView)Sets theTextureViewonto which video will be rendered.voidsetVolume(float volume)Sets the audio volume, valid values are between 0 (silence) and 1 (unity gain, signal unchanged), inclusive.voidstop()Stops playback without resetting the playlist.voidstop(boolean reset)-
Methods inherited from class com.google.android.exoplayer2.BasePlayer
addMediaItem, addMediaItem, addMediaItems, canAdvertiseSession, clearMediaItems, getBufferedPercentage, getContentDuration, getCurrentLiveOffset, getCurrentManifest, getCurrentMediaItem, getCurrentWindowIndex, getMediaItemAt, getMediaItemCount, getNextMediaItemIndex, getNextWindowIndex, getPreviousMediaItemIndex, getPreviousWindowIndex, hasNext, hasNextMediaItem, hasNextWindow, hasPrevious, hasPreviousMediaItem, hasPreviousWindow, isCommandAvailable, isCurrentMediaItemDynamic, isCurrentMediaItemLive, isCurrentMediaItemSeekable, isCurrentWindowDynamic, isCurrentWindowLive, isCurrentWindowSeekable, isPlaying, moveMediaItem, next, pause, play, previous, removeMediaItem, repeatCurrentMediaItem, seekBack, seekForward, seekTo, seekToDefaultPosition, seekToDefaultPosition, seekToNext, seekToNextMediaItem, seekToNextWindow, seekToPrevious, seekToPreviousMediaItem, seekToPreviousWindow, setMediaItem, setMediaItem, setMediaItem, setMediaItems, setPlaybackSpeed
-
-
-
-
Method Detail
-
addListener
public final void addListener(Player.Listener listener)
Description copied from interface:PlayerRegisters a listener to receive all events from the player.The listener's methods will be called on the thread associated with
Player.getApplicationLooper().- Parameters:
listener- The listener to register.
-
removeListener
public final void removeListener(Player.Listener listener)
Description copied from interface:PlayerUnregister a listener registered throughPlayer.addListener(Listener). The listener will no longer receive events.- Parameters:
listener- The listener to unregister.
-
getApplicationLooper
public final Looper getApplicationLooper()
Description copied from interface:PlayerReturns theLooperassociated with the application thread that's used to access the player and on which player events are received.
-
getAvailableCommands
public final Player.Commands getAvailableCommands()
Description copied from interface:PlayerReturns the player's currently availablePlayer.Commands.The returned
Player.Commandsare not updated when available commands change. UsePlayer.Listener.onAvailableCommandsChanged(Commands)to get an update when the available commands change.Executing a command that is not available (for example, calling
Player.seekToNextMediaItem()ifPlayer.COMMAND_SEEK_TO_NEXT_MEDIA_ITEMis unavailable) will neither throw an exception nor generate aPlayer.getPlayerError()player error}.Player.COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEMandPlayer.COMMAND_SEEK_TO_NEXT_MEDIA_ITEMare unavailable if there is no suchMediaItem.- Returns:
- The currently available
Player.Commands. - See Also:
Player.Listener.onAvailableCommandsChanged(com.google.android.exoplayer2.Player.Commands)
-
setPlayWhenReady
public final void setPlayWhenReady(boolean playWhenReady)
Description copied from interface:PlayerSets whether playback should proceed whenPlayer.getPlaybackState()==Player.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
public final boolean getPlayWhenReady()
Description copied from interface:PlayerWhether playback will proceed whenPlayer.getPlaybackState()==Player.STATE_READY.- Returns:
- Whether playback will proceed when ready.
- See Also:
Player.Listener.onPlayWhenReadyChanged(boolean, int)
-
setMediaItems
public final void setMediaItems(List<MediaItem> mediaItems, boolean resetPosition)
Description copied from interface:PlayerClears 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 byPlayer.getCurrentMediaItemIndex()andPlayer.getCurrentPosition().
-
setMediaItems
public final void setMediaItems(List<MediaItem> mediaItems, int startIndex, long startPositionMs)
Description copied from interface:PlayerClears the playlist and adds the specifiedMediaItems.- Parameters:
mediaItems- The newMediaItems.startIndex- TheMediaItemindex to start playback from. IfC.INDEX_UNSETis passed, the current position is not reset.startPositionMs- The position in milliseconds to start playback from. IfC.TIME_UNSETis passed, the default position of the givenMediaItemis used. In any case, ifstartIndexis set toC.INDEX_UNSET, this parameter is ignored and the position is not reset at all.
-
addMediaItems
public final void addMediaItems(int index, List<MediaItem> mediaItems)Description copied from interface:PlayerAdds 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- TheMediaItemsto add.
-
moveMediaItems
public final void moveMediaItems(int fromIndex, int toIndex, int newIndex)Description copied from interface:PlayerMoves 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.
-
removeMediaItems
public final void removeMediaItems(int fromIndex, int toIndex)Description copied from interface:PlayerRemoves 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.
-
prepare
public final void prepare()
Description copied from interface:PlayerPrepares the player.This will move the player out of
idle stateand the player will start loading media and acquire resources needed for playback.
-
getPlaybackState
public final int getPlaybackState()
Description copied from interface:PlayerReturns the currentplayback stateof the player.- Returns:
- The current
playback state. - See Also:
Player.Listener.onPlaybackStateChanged(int)
-
getPlaybackSuppressionReason
public final int getPlaybackSuppressionReason()
Description copied from interface:PlayerReturns the reason why playback is suppressed even thoughPlayer.getPlayWhenReady()istrue, orPlayer.PLAYBACK_SUPPRESSION_REASON_NONEif playback is not suppressed.- Returns:
- The current
playback suppression reason. - See Also:
Player.Listener.onPlaybackSuppressionReasonChanged(int)
-
getPlayerError
@Nullable public final PlaybackException getPlayerError()
Description copied from interface:PlayerReturns the error that caused playback to fail. This is the same error that will have been reported viaPlayer.Listener.onPlayerError(PlaybackException)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
nullifPlayer.getPlaybackState()is notPlayer.STATE_IDLE.- Returns:
- The error, or
null. - See Also:
Player.Listener.onPlayerError(PlaybackException)
-
setRepeatMode
public final void setRepeatMode(int repeatMode)
Description copied from interface:PlayerSets thePlayer.RepeatModeto be used for playback.- Parameters:
repeatMode- The repeat mode.
-
getRepeatMode
public final int getRepeatMode()
Description copied from interface:PlayerReturns the currentPlayer.RepeatModeused for playback.- Returns:
- The current repeat mode.
- See Also:
Player.Listener.onRepeatModeChanged(int)
-
setShuffleModeEnabled
public final void setShuffleModeEnabled(boolean shuffleModeEnabled)
Description copied from interface:PlayerSets whether shuffling of media items is enabled.- Parameters:
shuffleModeEnabled- Whether shuffling is enabled.
-
getShuffleModeEnabled
public final boolean getShuffleModeEnabled()
Description copied from interface:PlayerReturns whether shuffling of media items is enabled.
-
isLoading
public final boolean isLoading()
Description copied from interface:PlayerWhether the player is currently loading the source.- Returns:
- Whether the player is currently loading the source.
- See Also:
Player.Listener.onIsLoadingChanged(boolean)
-
seekTo
public final void seekTo(int mediaItemIndex, long positionMs)Description copied from interface:PlayerSeeks to a position specified in milliseconds in the specifiedMediaItem.- Parameters:
mediaItemIndex- The index of theMediaItem.positionMs- The seek position in the specifiedMediaItem, orC.TIME_UNSETto seek to the media item's default position.
-
getSeekBackIncrement
public final long getSeekBackIncrement()
Description copied from interface:PlayerReturns thePlayer.seekBack()increment.- Returns:
- The seek back increment, in milliseconds.
- See Also:
Player.Listener.onSeekBackIncrementChanged(long)
-
getSeekForwardIncrement
public final long getSeekForwardIncrement()
Description copied from interface:PlayerReturns thePlayer.seekForward()increment.- Returns:
- The seek forward increment, in milliseconds.
- See Also:
Player.Listener.onSeekForwardIncrementChanged(long)
-
getMaxSeekToPreviousPosition
public final long getMaxSeekToPreviousPosition()
Description copied from interface:PlayerReturns the maximum position for whichPlayer.seekToPrevious()seeks to the previousMediaItem, in milliseconds.- Returns:
- The maximum seek to previous position, in milliseconds.
- See Also:
Player.Listener.onMaxSeekToPreviousPositionChanged(long)
-
setPlaybackParameters
public final void setPlaybackParameters(PlaybackParameters playbackParameters)
Description copied from interface:PlayerAttempts to set the playback parameters. PassingPlaybackParameters.DEFAULTresets the player to the default, which means there is no speed or pitch adjustment.Playback parameters changes may cause the player to buffer.
Player.Listener.onPlaybackParametersChanged(PlaybackParameters)will be called whenever the currently active playback parameters change.- Parameters:
playbackParameters- The playback parameters.
-
getPlaybackParameters
public final PlaybackParameters getPlaybackParameters()
Description copied from interface:PlayerReturns the currently active playback parameters.
-
stop
public final void stop()
Description copied from interface:PlayerStops playback without resetting the playlist. UsePlayer.pause()rather than this method if the intention is to pause playback.Calling this method will cause the playback state to transition to
Player.STATE_IDLEand the player will release the loaded media and resources required for playback. The player instance can still be used by callingPlayer.prepare()again, andPlayer.release()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
public final void stop(boolean reset)
-
release
public final void release()
Description copied from interface:PlayerReleases the player. This method must be called when the player is no longer required. The player must not be used after calling this method.
-
getCurrentTracks
public final Tracks getCurrentTracks()
Description copied from interface:PlayerReturns the current tracks.- See Also:
Player.Listener.onTracksChanged(Tracks)
-
getTrackSelectionParameters
public final TrackSelectionParameters getTrackSelectionParameters()
Description copied from interface:PlayerReturns the parameters constraining the track selection.- See Also:
}
-
setTrackSelectionParameters
public final void setTrackSelectionParameters(TrackSelectionParameters parameters)
Description copied from interface:PlayerSets the parameters constraining the track selection.Unsupported parameters will be silently ignored.
Use
Player.getTrackSelectionParameters()to retrieve the current parameters. For example, the following snippet restricts video to SD whilst keep other track selection parameters unchanged:player.setTrackSelectionParameters( player.getTrackSelectionParameters() .buildUpon() .setMaxVideoSizeSd() .build())
-
getMediaMetadata
public final MediaMetadata getMediaMetadata()
Description copied from interface:PlayerReturns the current combinedMediaMetadata, orMediaMetadata.EMPTYif not supported.This
MediaMetadatais a combination of theMediaItem metadata, the static metadata in the media'sFormat, and any timed metadata that has been parsed from the media and output viaPlayer.Listener.onMetadata(Metadata). If a field is populated in theMediaItem.mediaMetadata, it will be prioritised above the same field coming from static or timed metadata.
-
getPlaylistMetadata
public final MediaMetadata getPlaylistMetadata()
Description copied from interface:PlayerReturns the playlistMediaMetadata, as set byPlayer.setPlaylistMetadata(MediaMetadata), orMediaMetadata.EMPTYif not supported.
-
setPlaylistMetadata
public final void setPlaylistMetadata(MediaMetadata mediaMetadata)
Description copied from interface:PlayerSets the playlistMediaMetadata.
-
getCurrentTimeline
public final Timeline getCurrentTimeline()
Description copied from interface:PlayerReturns the currentTimeline. Never null, but may be empty.
-
getCurrentPeriodIndex
public final int getCurrentPeriodIndex()
Description copied from interface:PlayerReturns the index of the period currently being played.
-
getCurrentMediaItemIndex
public final int getCurrentMediaItemIndex()
Description copied from interface:PlayerReturns the index of the currentMediaItemin thetimeline, or the prospective index if thecurrent timelineis empty.
-
getDuration
public final long getDuration()
Description copied from interface:PlayerReturns the duration of the current content or ad in milliseconds, orC.TIME_UNSETif the duration is not known.
-
getCurrentPosition
public final long getCurrentPosition()
Description copied from interface:PlayerReturns the playback position in the current content or ad, in milliseconds, or the prospective position in milliseconds if thecurrent timelineis empty.
-
getBufferedPosition
public final long getBufferedPosition()
Description copied from interface:PlayerReturns an estimate of the position in the current content or ad up to which data is buffered, in milliseconds.
-
getTotalBufferedDuration
public final long getTotalBufferedDuration()
Description copied from interface:PlayerReturns an estimate of the total buffered duration from the current position, in milliseconds. This includes pre-buffered data for subsequent ads andmedia items.
-
isPlayingAd
public final boolean isPlayingAd()
Description copied from interface:PlayerReturns whether the player is currently playing an ad.
-
getCurrentAdGroupIndex
public final int getCurrentAdGroupIndex()
Description copied from interface:PlayerIfPlayer.isPlayingAd()returns true, returns the index of the ad group in the period currently being played. ReturnsC.INDEX_UNSETotherwise.
-
getCurrentAdIndexInAdGroup
public final int getCurrentAdIndexInAdGroup()
Description copied from interface:PlayerIfPlayer.isPlayingAd()returns true, returns the index of the ad in its ad group. ReturnsC.INDEX_UNSETotherwise.
-
getContentPosition
public final long getContentPosition()
Description copied from interface:PlayerIfPlayer.isPlayingAd()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 byPlayer.getCurrentPosition().
-
getContentBufferedPosition
public final long getContentBufferedPosition()
Description copied from interface:PlayerIfPlayer.isPlayingAd()returnstrue, returns an estimate of the content position in the current content up to which data is buffered, in milliseconds. If there is no ad playing, the returned position is the same as that returned byPlayer.getBufferedPosition().
-
getAudioAttributes
public final AudioAttributes getAudioAttributes()
Description copied from interface:PlayerReturns the attributes for audio playback.
-
setVolume
public final void setVolume(float volume)
Description copied from interface:PlayerSets the audio volume, valid values are between 0 (silence) and 1 (unity gain, signal unchanged), inclusive.- Parameters:
volume- Linear output gain to apply to all audio channels.
-
getVolume
public final float getVolume()
Description copied from interface:PlayerReturns the audio volume, with 0 being silence and 1 being unity gain (signal unchanged).- Returns:
- The linear gain applied to all audio channels.
-
clearVideoSurface
public final void clearVideoSurface()
Description copied from interface:Player
-
clearVideoSurface
public final void clearVideoSurface(@Nullable Surface surface)Description copied from interface:PlayerClears theSurfaceonto which video is being rendered if it matches the one passed. Else does nothing.- Parameters:
surface- The surface to clear.
-
setVideoSurface
public final void setVideoSurface(@Nullable Surface surface)Description copied from interface:PlayerSets theSurfaceonto 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,TextureVieworSurfaceHolderthen it's recommended to usePlayer.setVideoSurfaceView(SurfaceView),Player.setVideoTextureView(TextureView)orPlayer.setVideoSurfaceHolder(SurfaceHolder)rather than this method, since passing the holder allows the player to track the lifecycle of the surface automatically.- Parameters:
surface- TheSurface.
-
setVideoSurfaceHolder
public final void setVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)Description copied from interface:PlayerSets theSurfaceHolderthat holds theSurfaceonto which video will be rendered. The player will track the lifecycle of the surface automatically.The thread that calls the
SurfaceHolder.Callbackmethods must be the thread associated withPlayer.getApplicationLooper().- Parameters:
surfaceHolder- The surface holder.
-
clearVideoSurfaceHolder
public final void clearVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)Description copied from interface:PlayerClears theSurfaceHolderthat holds theSurfaceonto which video is being rendered if it matches the one passed. Else does nothing.- Parameters:
surfaceHolder- The surface holder to clear.
-
setVideoSurfaceView
public final void setVideoSurfaceView(@Nullable SurfaceView surfaceView)Description copied from interface:PlayerSets theSurfaceViewonto which video will be rendered. The player will track the lifecycle of the surface automatically.The thread that calls the
SurfaceHolder.Callbackmethods must be the thread associated withPlayer.getApplicationLooper().- Parameters:
surfaceView- The surface view.
-
clearVideoSurfaceView
public final void clearVideoSurfaceView(@Nullable SurfaceView surfaceView)Description copied from interface:PlayerClears theSurfaceViewonto which video is being rendered if it matches the one passed. Else does nothing.- Parameters:
surfaceView- The texture view to clear.
-
setVideoTextureView
public final void setVideoTextureView(@Nullable TextureView textureView)Description copied from interface:PlayerSets theTextureViewonto which video will be rendered. The player will track the lifecycle of the surface automatically.The thread that calls the
TextureView.SurfaceTextureListenermethods must be the thread associated withPlayer.getApplicationLooper().- Parameters:
textureView- The texture view.
-
clearVideoTextureView
public final void clearVideoTextureView(@Nullable TextureView textureView)Description copied from interface:PlayerClears theTextureViewonto which video is being rendered if it matches the one passed. Else does nothing.- Parameters:
textureView- The texture view to clear.
-
getVideoSize
public final VideoSize getVideoSize()
Description copied from interface:PlayerGets the size of the video.The video's width and height are
0if there is no video or its size has not been determined yet.
-
getSurfaceSize
public final Size getSurfaceSize()
Description copied from interface:PlayerGets the size of the surface on which the video is rendered.
-
getCurrentCues
public final CueGroup getCurrentCues()
Description copied from interface:PlayerReturns the currentCueGroup.
-
getDeviceInfo
public final DeviceInfo getDeviceInfo()
Description copied from interface:PlayerGets the device information.
-
getDeviceVolume
public final int getDeviceVolume()
Description copied from interface:PlayerGets 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.usagewhich can be converted to stream type withUtil.getStreamTypeForAudioUsage(int).For devices with
remote playback, the volume of the remote device is returned.
-
isDeviceMuted
public final boolean isDeviceMuted()
Description copied from interface:PlayerGets whether the device is muted or not.
-
setDeviceVolume
public final void setDeviceVolume(int volume)
Description copied from interface:PlayerSets the volume of the device.- Parameters:
volume- The volume to set.
-
increaseDeviceVolume
public final void increaseDeviceVolume()
Description copied from interface:PlayerIncreases the volume of the device.
-
decreaseDeviceVolume
public final void decreaseDeviceVolume()
Description copied from interface:PlayerDecreases the volume of the device.
-
setDeviceMuted
public final void setDeviceMuted(boolean muted)
Description copied from interface:PlayerSets the mute state of the device.
-
invalidateState
protected final void invalidateState()
Invalidates the current state.Triggers a call to
getState()and informs listeners if the state changed.Note that this may not have an immediate effect while there are still player methods being handled asynchronously. The state will be invalidated automatically once these pending synchronous operations are finished and there is no need to call this method again.
-
getState
@ForOverride protected abstract SimpleBasePlayer.State getState()
Returns the currentSimpleBasePlayer.Stateof the player.The
SimpleBasePlayer.Stateshould include all available commands indicating which player methods are allowed to be called.Note that this method won't be called while asynchronous handling of player methods is in progress. This means that the implementation doesn't need to handle state changes caused by these asynchronous operations until they are done and can return the currently known state directly. The placeholder state used while these asynchronous operations are in progress can be customized by overriding
getPlaceholderState(State)if required.
-
getPlaceholderState
@ForOverride protected SimpleBasePlayer.State getPlaceholderState(SimpleBasePlayer.State suggestedPlaceholderState)
Returns the placeholder state used while a player method is handled asynchronously.The
suggestedPlaceholderStatealready contains the most likely state update, for example settingSimpleBasePlayer.State.playWhenReadyto true ifplayer.setPlayWhenReady(true)is called, and an implementations only needs to override this method if it can determine a more accurate placeholder state.- Parameters:
suggestedPlaceholderState- The suggested placeholderSimpleBasePlayer.State, including the most likely outcome of handling all pending asynchronous operations.- Returns:
- The placeholder
SimpleBasePlayer.Stateto use while asynchronous operations are pending.
-
handleSetPlayWhenReady
@ForOverride protected ListenableFuture<?> handleSetPlayWhenReady(boolean playWhenReady)
Handles calls to setSimpleBasePlayer.State.playWhenReady.Will only be called if
Player.COMMAND_PLAY_PAUSEis available.- Parameters:
playWhenReady- The requestedSimpleBasePlayer.State.playWhenReady- Returns:
- A
ListenableFutureindicating the completion of all immediateSimpleBasePlayer.Statechanges caused by this call. - See Also:
Player.setPlayWhenReady(boolean),Player.play(),Player.pause()
-
-