DefaultLoadControl (library-core API)

java.lang.Object
- com.google.android.exoplayer2.DefaultLoadControl

All Implemented Interfaces:: LoadControl

public final class DefaultLoadControl
extends java.lang.Object
implements LoadControl

The default LoadControl implementation.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BUFFER_FOR_PLAYBACK_AFTER_REBUFFER_MS` The default duration of media that must be buffered for playback to resume after a rebuffer, in milliseconds.
`static int`	`DEFAULT_BUFFER_FOR_PLAYBACK_MS` The default duration of media that must be buffered for playback to start or resume following a user action such as a seek, in milliseconds.
`static int`	`DEFAULT_MAX_BUFFER_MS` The default maximum duration of media that the player will attempt to buffer, in milliseconds.
`static int`	`DEFAULT_MIN_BUFFER_MS` The default minimum duration of media that the player will attempt to ensure is buffered at all times, in milliseconds.

Constructor Summary

Constructors
Constructor and Description
`DefaultLoadControl()` Constructs a new instance, using the `DEFAULT_*` constants defined in this class.
`DefaultLoadControl(DefaultAllocator allocator)` Constructs a new instance, using the `DEFAULT_*` constants defined in this class.
`DefaultLoadControl(DefaultAllocator allocator, int minBufferMs, int maxBufferMs, long bufferForPlaybackMs, long bufferForPlaybackAfterRebufferMs)` Constructs a new instance.
`DefaultLoadControl(DefaultAllocator allocator, int minBufferMs, int maxBufferMs, long bufferForPlaybackMs, long bufferForPlaybackAfterRebufferMs, PriorityTaskManager priorityTaskManager)` Constructs a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Allocator`	`getAllocator()` Returns the `Allocator` that should be used to obtain media buffer allocations.
`void`	`onPrepared()` Called by the player when prepared with a new source.
`void`	`onReleased()` Called by the player when released.
`void`	`onStopped()` Called by the player when stopped.
`void`	`onTracksSelected(Renderer[] renderers, TrackGroupArray trackGroups, TrackSelectionArray trackSelections)` Called by the player when a track selection occurs.
`boolean`	`shouldContinueLoading(long bufferedDurationUs)` Called by the player to determine whether it should continue to load the source.
`boolean`	`shouldStartPlayback(long bufferedDurationUs, boolean rebuffering)` Called by the player to determine whether sufficient media is buffered for playback to be started or resumed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_MIN_BUFFER_MS
```
public static final int DEFAULT_MIN_BUFFER_MS
```
    The default minimum duration of media that the player will attempt to ensure is buffered at all times, in milliseconds.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_BUFFER_MS
```
public static final int DEFAULT_MAX_BUFFER_MS
```
    The default maximum duration of media that the player will attempt to buffer, in milliseconds.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BUFFER_FOR_PLAYBACK_MS
```
public static final int DEFAULT_BUFFER_FOR_PLAYBACK_MS
```
    The default duration of media that must be buffered for playback to start or resume following a user action such as a seek, in milliseconds.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BUFFER_FOR_PLAYBACK_AFTER_REBUFFER_MS
```
public static final int DEFAULT_BUFFER_FOR_PLAYBACK_AFTER_REBUFFER_MS
```
    The default duration of media that must be buffered for playback to resume after a rebuffer, in milliseconds. A rebuffer is defined to be caused by buffer depletion rather than a user action.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DefaultLoadControl
```
public DefaultLoadControl()
```
    Constructs a new instance, using the DEFAULT_* constants defined in this class.
  - DefaultLoadControl
```
public DefaultLoadControl(DefaultAllocator allocator)
```
    Constructs a new instance, using the DEFAULT_* constants defined in this class.
    
    Parameters:
    
    allocator - The DefaultAllocator used by the loader.
  - DefaultLoadControl
```
public DefaultLoadControl(DefaultAllocator allocator,
                          int minBufferMs,
                          int maxBufferMs,
                          long bufferForPlaybackMs,
                          long bufferForPlaybackAfterRebufferMs)
```
    Constructs a new instance.
    
    Parameters:
    
    allocator - The DefaultAllocator used by the loader.
    
    minBufferMs - The minimum duration of media that the player will attempt to ensure is buffered at all times, in milliseconds.
    
    maxBufferMs - The maximum duration of media that the player will attempt buffer, in milliseconds.
    
    bufferForPlaybackMs - The duration of media that must be buffered for playback to start or resume following a user action such as a seek, in milliseconds.
    
    bufferForPlaybackAfterRebufferMs - The default duration of media that must be buffered for playback to resume after a rebuffer, in milliseconds. A rebuffer is defined to be caused by buffer depletion rather than a user action.
  - DefaultLoadControl
```
public DefaultLoadControl(DefaultAllocator allocator,
                          int minBufferMs,
                          int maxBufferMs,
                          long bufferForPlaybackMs,
                          long bufferForPlaybackAfterRebufferMs,
                          PriorityTaskManager priorityTaskManager)
```
    Constructs a new instance.
    
    Parameters:
    
    allocator - The DefaultAllocator used by the loader.
    
    minBufferMs - The minimum duration of media that the player will attempt to ensure is buffered at all times, in milliseconds.
    
    maxBufferMs - The maximum duration of media that the player will attempt buffer, in milliseconds.
    
    bufferForPlaybackMs - The duration of media that must be buffered for playback to start or resume following a user action such as a seek, in milliseconds.
    
    bufferForPlaybackAfterRebufferMs - The default duration of media that must be buffered for playback to resume after a rebuffer, in milliseconds. A rebuffer is defined to be caused by buffer depletion rather than a user action.
    
    priorityTaskManager - If not null, registers itself as a task with priority C.PRIORITY_PLAYBACK during loading periods, and unregisters itself during draining periods.
- Method Detail
  - onPrepared
```
public void onPrepared()
```
    Description copied from interface: LoadControl
    
    Called by the player when prepared with a new source.
    
    Specified by:
    
    onPrepared in interface LoadControl
  - onTracksSelected
```
public void onTracksSelected(Renderer[] renderers,
                             TrackGroupArray trackGroups,
                             TrackSelectionArray trackSelections)
```
    Description copied from interface: LoadControl
    
    Called by the player when a track selection occurs.
    
    Specified by:
    
    onTracksSelected in interface LoadControl
    
    Parameters:
    
    renderers - The renderers.
    
    trackGroups - The TrackGroups from which the selection was made.
    
    trackSelections - The track selections that were made.
  - onStopped
```
public void onStopped()
```
    Description copied from interface: LoadControl
    
    Called by the player when stopped.
    
    Specified by:
    
    onStopped in interface LoadControl
  - onReleased
```
public void onReleased()
```
    Description copied from interface: LoadControl
    
    Called by the player when released.
    
    Specified by:
    
    onReleased in interface LoadControl
  - getAllocator
```
public Allocator getAllocator()
```
    Description copied from interface: LoadControl
    
    Returns the Allocator that should be used to obtain media buffer allocations.
    
    Specified by:
    
    getAllocator in interface LoadControl
  - shouldStartPlayback
```
public boolean shouldStartPlayback(long bufferedDurationUs,
                                   boolean rebuffering)
```
    Description copied from interface: LoadControl
    
    Called by the player to determine whether sufficient media is buffered for playback to be started or resumed.
    
    Specified by:
    
    shouldStartPlayback in interface LoadControl
    
    Parameters:
    
    bufferedDurationUs - The duration of media that's currently buffered.
    
    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.
    
    Returns:
    
    Whether playback should be allowed to start or resume.
  - shouldContinueLoading
```
public boolean shouldContinueLoading(long bufferedDurationUs)
```
    Description copied from interface: LoadControl
    
    Called by the player to determine whether it should continue to load the source.
    
    Specified by:
    
    shouldContinueLoading in interface LoadControl
    
    Parameters:
    
    bufferedDurationUs - The duration of media that's currently buffered.
    
    Returns:
    
    Whether the loading should continue.

Class DefaultLoadControl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MIN_BUFFER_MS

DEFAULT_MAX_BUFFER_MS

DEFAULT_BUFFER_FOR_PLAYBACK_MS

DEFAULT_BUFFER_FOR_PLAYBACK_AFTER_REBUFFER_MS

Constructor Detail

DefaultLoadControl

DefaultLoadControl

DefaultLoadControl

DefaultLoadControl

Method Detail

onPrepared

onTracksSelected

onStopped

onReleased

getAllocator

shouldStartPlayback

shouldContinueLoading