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 inheriting BasePlayer 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:

    • Field Detail

      • STATE_IDLE

        static final int STATE_IDLE
        The player does not have any media to play.
        See Also:
        Constant Field Values
      • STATE_BUFFERING

        static final int STATE_BUFFERING
        The player is not able to immediately play from its current position. This state typically occurs when more data needs to be loaded.
        See Also:
        Constant Field Values
      • STATE_READY

        static final int STATE_READY
        The player is able to immediately play from its current position. The player will be playing if getPlayWhenReady() is true, and paused otherwise.
        See Also:
        Constant Field Values
      • STATE_ENDED

        static final int STATE_ENDED
        The player has finished playing the media.
        See Also:
        Constant Field Values
      • 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 in REPEAT_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 in REPEAT_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 the Timeline.
        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
      • 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 the MediaItem 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 its MediaItems.
        See Also:
        Constant Field Values
      • COMMAND_GET_MEDIA_ITEMS_METADATA

        static final int COMMAND_GET_MEDIA_ITEMS_METADATA
        Command to get the MediaItems metadata.
        See Also:
        Constant Field Values
      • COMMAND_CHANGE_MEDIA_ITEMS

        static final int COMMAND_CHANGE_MEDIA_ITEMS
        Command to change the MediaItems in the playlist.
        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 the Looper 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.
        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 a Looper, 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

        void removeListener​(Player.Listener listener)
        Unregister a listener registered through addListener(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 specified MediaItems and resets the position to the default position.
        Parameters:
        mediaItems - The new MediaItems.
      • setMediaItems

        void setMediaItems​(List<MediaItem> mediaItems,
                           int startWindowIndex,
                           long startPositionMs)
        Clears the playlist and adds the specified MediaItems.
        Parameters:
        mediaItems - The new MediaItems.
        startWindowIndex - The window index to start playback from. If C.INDEX_UNSET is passed, the current position is not reset.
        startPositionMs - The position in milliseconds to start playback from. If C.TIME_UNSET is passed, the default position of the given window is used. In any case, if startWindowIndex is set to C.INDEX_UNSET, this parameter is ignored and the position is not reset at all.
        Throws:
        IllegalSeekPositionException - If the provided startWindowIndex is not within the bounds of the list of media items.
      • setMediaItem

        void setMediaItem​(MediaItem mediaItem)
        Clears the playlist, adds the specified MediaItem and resets the position to the default position.
        Parameters:
        mediaItem - The new MediaItem.
      • setMediaItem

        void setMediaItem​(MediaItem mediaItem,
                          long startPositionMs)
        Clears the playlist and adds the specified MediaItem.
        Parameters:
        mediaItem - The new MediaItem.
        startPositionMs - The position in milliseconds to start playback from.
      • setMediaItem

        void setMediaItem​(MediaItem mediaItem,
                          boolean resetPosition)
        Clears the playlist and adds the specified MediaItem.
        Parameters:
        mediaItem - The new MediaItem.
        resetPosition - Whether the playback position should be reset to the default position. If false, playback will start from the position defined by getCurrentWindowIndex() and getCurrentPosition().
      • addMediaItem

        void addMediaItem​(MediaItem mediaItem)
        Adds a media item to the end of the playlist.
        Parameters:
        mediaItem - The MediaItem 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 - The MediaItem to add.
      • addMediaItems

        void addMediaItems​(List<MediaItem> mediaItems)
        Adds a list of media items to the end of the playlist.
        Parameters:
        mediaItems - The MediaItems 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 - The MediaItems 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.
      • prepare

        void prepare()
        Prepares the player.
      • pause

        void pause()
        Pauses playback. Equivalent to setPlayWhenReady(false).
      • setPlayWhenReady

        void setPlayWhenReady​(boolean playWhenReady)
        Sets whether playback should proceed when getPlaybackState() == STATE_READY.

        If the player is already in the ready state then this method pauses and resumes playback.

        Parameters:
        playWhenReady - Whether playback should proceed when ready.
      • setRepeatMode

        void setRepeatMode​(@RepeatMode
                           int repeatMode)
        Sets the Player.RepeatMode to be used for playback.
        Parameters:
        repeatMode - The repeat mode.
      • setShuffleModeEnabled

        void setShuffleModeEnabled​(boolean shuffleModeEnabled)
        Sets whether shuffling of windows is enabled.
        Parameters:
        shuffleModeEnabled - Whether shuffling is enabled.
      • 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 provided windowIndex 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, or C.TIME_UNSET to seek to the window's default position.
      • seekTo

        void seekTo​(int windowIndex,
                    long positionMs)
        Seeks to a position specified in milliseconds in the specified window.
        Parameters:
        windowIndex - The index of the window.
        positionMs - The seek position in the specified window, or C.TIME_UNSET to seek to the window's default position.
        Throws:
        IllegalSeekPositionException - If the player has a non-empty timeline and the provided windowIndex 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 is REPEAT_MODE_OFF. See REPEAT_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 if hasPrevious() is false.

        Note: When the repeat mode is REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is REPEAT_MODE_OFF. See REPEAT_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 is REPEAT_MODE_OFF. See REPEAT_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 if hasNext() is false.

        Note: When the repeat mode is REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is REPEAT_MODE_OFF. See REPEAT_MODE_ONE for more details.

      • 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...
      • stop

        void stop()
        Stops playback without resetting the player. Use pause() rather than this method if the intention is to pause playback.

        Calling this method will cause the playback state to transition to STATE_IDLE. The player instance can still be used, and release() must still be called on the player if it's no longer required.

        Calling this method does not clear the playlist, reset the playback position or the playback error.

      • 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.
      • getCurrentStaticMetadata

        List<Metadata> getCurrentStaticMetadata()
        Returns the current static metadata for the track selections.

        The returned metadataList is an immutable list of Metadata instances, where the elements correspond to the current 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.

        See Also:
        Player.EventListener.onStaticMetadataChanged(List)
      • getCurrentManifest

        @Nullable
        Object getCurrentManifest()
        Returns the current manifest. The type depends on the type of media being played. May be null.
      • getCurrentPeriodIndex

        int getCurrentPeriodIndex()
        Returns the index of the period currently being played.
      • getCurrentWindowIndex

        int getCurrentWindowIndex()
        Returns the index of the current window in the timeline, or the prospective window index if the current timeline is empty.
      • getNextWindowIndex

        int getNextWindowIndex()
        Returns the index of the window that will be played if next() is called, which may depend on the current repeat mode and whether shuffle mode is enabled. Returns C.INDEX_UNSET if hasNext() is false.

        Note: When the repeat mode is REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is REPEAT_MODE_OFF. See REPEAT_MODE_ONE for more details.

      • getPreviousWindowIndex

        int getPreviousWindowIndex()
        Returns the index of the window that will be played if previous() is called, which may depend on the current repeat mode and whether shuffle mode is enabled. Returns C.INDEX_UNSET if hasPrevious() is false.

        Note: When the repeat mode is REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is REPEAT_MODE_OFF. See REPEAT_MODE_ONE for more details.

      • getMediaItemCount

        int getMediaItemCount()
        Returns the number of media items in the playlist.
      • getMediaItemAt

        MediaItem getMediaItemAt​(int index)
        Returns the MediaItem at the given index.
      • getDuration

        long getDuration()
        Returns the duration of the current content window or ad in milliseconds, or C.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 the current 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, or false if the Timeline is empty.
        See Also:
        Timeline.Window.isDynamic
      • isCurrentWindowLive

        boolean isCurrentWindowLive()
        Returns whether the current window is live, or false if the Timeline is empty.
        See Also:
        Timeline.Window.isLive()
      • getCurrentLiveOffset

        long getCurrentLiveOffset()
        Returns the offset of the current playback position from the live edge in milliseconds, or C.TIME_UNSET if the current window isn'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, or false if the Timeline is empty.
        See Also:
        Timeline.Window.isSeekable
      • isPlayingAd

        boolean isPlayingAd()
        Returns whether the player is currently playing an ad.
      • getCurrentAdGroupIndex

        int getCurrentAdGroupIndex()
        If isPlayingAd() returns true, returns the index of the ad group in the period currently being played. Returns C.INDEX_UNSET otherwise.
      • getCurrentAdIndexInAdGroup

        int getCurrentAdIndexInAdGroup()
        If isPlayingAd() returns true, returns the index of the ad in its ad group. Returns C.INDEX_UNSET otherwise.
      • getContentDuration

        long getContentDuration()
        If isPlayingAd() returns true, returns the duration of the current content window in milliseconds, or C.TIME_UNSET if the duration is not known. If there is no ad playing, the returned duration is the same as that returned by getDuration().
      • getContentPosition

        long getContentPosition()
        If isPlayingAd() returns true, returns the content position that will be played once all ads in the ad group have finished playing, in milliseconds. If there is no ad playing, the returned position is the same as that returned by getCurrentPosition().
      • getContentBufferedPosition

        long getContentBufferedPosition()
        If isPlayingAd() returns true, 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 by getBufferedPosition().
      • 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​(@Nullable
                               Surface surface)
        Clears the Surface onto which video is being rendered if it matches the one passed. Else does nothing.
        Parameters:
        surface - The surface to clear.
      • setVideoSurfaceHolder

        void setVideoSurfaceHolder​(@Nullable
                                   SurfaceHolder surfaceHolder)
        Sets the SurfaceHolder that holds the Surface 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 the SurfaceHolder that holds the Surface 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 the SurfaceView 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 the SurfaceView 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 the TextureView 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 the TextureView onto which video is being rendered if it matches the one passed. Else does nothing.
        Parameters:
        textureView - The texture view to clear.
      • getCurrentCues

        List<Cue> getCurrentCues()
        Returns the current Cues. This list may be empty.
      • getDeviceInfo

        DeviceInfo getDeviceInfo()
        Gets the device information.
      • 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.