Interface LoadControl

  • All Known Implementing Classes:
    DefaultLoadControl

    @Deprecated
    public interface LoadControl
    Deprecated.
    com.google.android.exoplayer2 is deprecated. Please migrate to androidx.media3 (which contains the same ExoPlayer code). See the migration guide for more details, including a script to help with the migration.
    Controls buffering of media.
    • Method Detail

      • onPrepared

        void onPrepared()
        Deprecated.
        Called by the player when prepared with a new source.
      • onStopped

        void onStopped()
        Deprecated.
        Called by the player when stopped.
      • onReleased

        void onReleased()
        Deprecated.
        Called by the player when released.
      • getAllocator

        Allocator getAllocator()
        Deprecated.
        Returns the Allocator that should be used to obtain media buffer allocations.
      • getBackBufferDurationUs

        long getBackBufferDurationUs()
        Deprecated.
        Returns the duration of media to retain in the buffer prior to the current playback position, for fast backward seeking.

        Note: If retainBackBufferFromKeyframe() is false then seeking in the back-buffer will only be fast if the back-buffer contains a keyframe prior to the seek position.

        Note: Implementations should return a single value. Dynamic changes to the back-buffer are not currently supported.

        Returns:
        The duration of media to retain in the buffer prior to the current playback position, in microseconds.
      • retainBackBufferFromKeyframe

        boolean retainBackBufferFromKeyframe()
        Deprecated.
        Returns whether media should be retained from the keyframe before the current playback position minus getBackBufferDurationUs(), rather than any sample before or at that position.

        Warning: Returning true will cause the back-buffer size to depend on the spacing of keyframes in the media being played. Returning true is not recommended unless you control the media and are comfortable with the back-buffer size exceeding getBackBufferDurationUs() by as much as the maximum duration between adjacent keyframes in the media.

        Note: Implementations should return a single value. Dynamic changes to the back-buffer are not currently supported.

        Returns:
        Whether media should be retained from the keyframe before the current playback position minus getBackBufferDurationUs(), rather than any sample before or at that position.
      • shouldStartPlayback

        default boolean shouldStartPlayback​(Timeline timeline,
                                            MediaPeriodId mediaPeriodId,
                                            long bufferedDurationUs,
                                            float playbackSpeed,
                                            boolean rebuffering,
                                            long targetLiveOffsetUs)
        Deprecated.
        Called repeatedly by the player when it's loading the source, has yet to start playback, and has the minimum amount of data necessary for playback to be started. The value returned determines whether playback is actually started. The load control may opt to return false until some condition has been met (e.g. a certain amount of media is buffered).
        Parameters:
        timeline - The current Timeline in ExoPlayer. Can be Timeline.EMPTY only when the deprecated shouldStartPlayback(long, float, boolean, long) was called.
        mediaPeriodId - Identifies (in the current timeline) the MediaPeriod for which playback will start. Will be EMPTY_MEDIA_PERIOD_ID when timeline is empty.
        bufferedDurationUs - The duration of media that's currently buffered.
        playbackSpeed - The current factor by which playback is sped up.
        rebuffering - Whether the player is rebuffering. A rebuffer is defined to be caused by buffer depletion rather than a user action. Hence this parameter is false during initial buffering and when buffering as a result of a seek operation.
        targetLiveOffsetUs - The desired playback position offset to the live edge in microseconds, or C.TIME_UNSET if the media is not a live stream or no offset is configured.
        Returns:
        Whether playback should be allowed to start or resume.