# ChunkSource

Artifact: [androidx.media3:media3-exoplayer](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/exoplayer/source/chunk/ChunkSource.java+class:androidx.media3.exoplayer.source.chunk.ChunkSource)

*** ** * ** ***


```
@UnstableApi
public interface ChunkSource
```

<br />

Known direct subclasses [DashChunkSource](https://developer.android.com/reference/androidx/media3/exoplayer/dash/DashChunkSource), [FakeChunkSource](https://developer.android.com/reference/androidx/media3/test/utils/FakeChunkSource), [SsChunkSource](https://developer.android.com/reference/androidx/media3/exoplayer/smoothstreaming/SsChunkSource)

|---|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/dash/DashChunkSource` | A `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSource` for DASH streams. |
| `https://developer.android.com/reference/androidx/media3/test/utils/FakeChunkSource` | Fake `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSource` with adaptive media chunks of a given duration. |
| `https://developer.android.com/reference/androidx/media3/exoplayer/smoothstreaming/SsChunkSource` | A `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSource` for SmoothStreaming. |

Known indirect subclasses [DefaultDashChunkSource](https://developer.android.com/reference/androidx/media3/exoplayer/dash/DefaultDashChunkSource), [DefaultSsChunkSource](https://developer.android.com/reference/androidx/media3/exoplayer/smoothstreaming/DefaultSsChunkSource)

|---|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/dash/DefaultDashChunkSource` | A default `https://developer.android.com/reference/androidx/media3/exoplayer/dash/DashChunkSource` implementation. |
| `https://developer.android.com/reference/androidx/media3/exoplayer/smoothstreaming/DefaultSsChunkSource` | A default `https://developer.android.com/reference/androidx/media3/exoplayer/smoothstreaming/SsChunkSource` implementation. |

*** ** * ** ***

A provider of `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/Chunk`s for a `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSampleStream` to load.

## Summary

| ### Public methods |
|---|---|
| `abstract long` | `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSource#getAdjustedSeekPositionUs(long,androidx.media3.exoplayer.SeekParameters)( long positionUs, https://developer.android.com/reference/androidx/media3/exoplayer/SeekParameters seekParameters )` Adjusts a seek position given the specified `https://developer.android.com/reference/androidx/media3/exoplayer/SeekParameters`. |
| `abstract void` | `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSource#getNextChunk(androidx.media3.exoplayer.LoadingInfo,long,java.util.List<? extends androidx.media3.exoplayer.source.chunk.MediaChunk>,androidx.media3.exoplayer.source.chunk.ChunkHolder)( https://developer.android.com/reference/androidx/media3/exoplayer/LoadingInfo loadingInfo, long loadPositionUs, https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/MediaChunk> queue, https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkHolder out )` Returns the next chunk to load. |
| `abstract int` | `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSource#getPreferredQueueSize(long,java.util.List<? extends androidx.media3.exoplayer.source.chunk.MediaChunk>)(long playbackPositionUs, https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/MediaChunk> queue)` Evaluates whether `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/MediaChunk`s should be removed from the back of the queue. |
| `abstract void` | `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSource#maybeThrowError()()` If the source is currently having difficulty providing chunks, then this method throws the underlying error. |
| `abstract void` | `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSource#onChunkLoadCompleted(androidx.media3.exoplayer.source.chunk.Chunk)(https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/Chunk chunk)` Called when the `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSampleStream` has finished loading a chunk obtained from this source. |
| `abstract boolean` | `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSource#onChunkLoadError(androidx.media3.exoplayer.source.chunk.Chunk,boolean,androidx.media3.exoplayer.upstream.LoadErrorHandlingPolicy.LoadErrorInfo,androidx.media3.exoplayer.upstream.LoadErrorHandlingPolicy)( https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/Chunk chunk, boolean cancelable, https://developer.android.com/reference/androidx/media3/exoplayer/upstream/LoadErrorHandlingPolicy.LoadErrorInfo loadErrorInfo, https://developer.android.com/reference/androidx/media3/exoplayer/upstream/LoadErrorHandlingPolicy loadErrorHandlingPolicy )` Called when the `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSampleStream` encounters an error loading a chunk obtained from this source. |
| `abstract void` | `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSource#release()()` Releases any held resources. |
| `abstract boolean` | `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSource#shouldCancelLoad(long,androidx.media3.exoplayer.source.chunk.Chunk,java.util.List<? extends androidx.media3.exoplayer.source.chunk.MediaChunk>)( long playbackPositionUs, https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/Chunk loadingChunk, https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/MediaChunk> queue )` Returns whether an ongoing load of a chunk should be canceled. |

## Public methods

### getAdjustedSeekPositionUs

```
abstract long getAdjustedSeekPositionUs(
    long positionUs,
    SeekParameters seekParameters
)
```

Adjusts a seek position given the specified `https://developer.android.com/reference/androidx/media3/exoplayer/SeekParameters`. Chunk boundaries are used as sync points.

| Parameters |
|---|---|
| `long positionUs` | The seek position in microseconds. |
| `https://developer.android.com/reference/androidx/media3/exoplayer/SeekParameters seekParameters` | Parameters that control how the seek is performed. |

| Returns |
|---|---|
| `long` | The adjusted seek position, in microseconds. |

### getNextChunk

```
abstract void getNextChunk(
    LoadingInfo loadingInfo,
    long loadPositionUs,
    List<MediaChunk> queue,
    ChunkHolder out
)
```

Returns the next chunk to load.

If a chunk is available then `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkHolder#chunk()` is set. If the end of the stream has been reached then `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkHolder#endOfStream()` is set. If a chunk is not available but the end of the stream has not been reached, the `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkHolder` is not modified.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/LoadingInfo loadingInfo` | The `https://developer.android.com/reference/androidx/media3/exoplayer/LoadingInfo` when loading request is made. |
| `long loadPositionUs` | The current load position in microseconds. If `queue` is empty, this is the starting position from which chunks should be provided. Else it's equal to `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/Chunk#endTimeUs()` of the last chunk in the `queue`. |
| `https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/MediaChunk> queue` | The queue of buffered `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/MediaChunk`s. |
| `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkHolder out` | A holder to populate. |

### getPreferredQueueSize

```
abstract int getPreferredQueueSize(long playbackPositionUs, List<MediaChunk> queue)
```

Evaluates whether `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/MediaChunk`s should be removed from the back of the queue.

Removing `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/MediaChunk`s from the back of the queue can be useful if they could be replaced with chunks of a significantly higher quality (e.g. because the available bandwidth has substantially increased).

Will only be called if no `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/MediaChunk` in the queue is currently loading.

| Parameters |
|---|---|
| `long playbackPositionUs` | The current playback position, in microseconds. |
| `https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/MediaChunk> queue` | The queue of buffered `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/MediaChunk`s. |

| Returns |
|---|---|
| `int` | The preferred queue size. |

### maybeThrowError

```
abstract void maybeThrowError()
```

If the source is currently having difficulty providing chunks, then this method throws the underlying error. Otherwise does nothing.

| Throws |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` | The underlying error. |

### onChunkLoadCompleted

```
abstract void onChunkLoadCompleted(Chunk chunk)
```

Called when the `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSampleStream` has finished loading a chunk obtained from this source.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/Chunk chunk` | The chunk whose load has been completed. |

### onChunkLoadError

```
abstract boolean onChunkLoadError(
    Chunk chunk,
    boolean cancelable,
    LoadErrorHandlingPolicy.LoadErrorInfo loadErrorInfo,
    LoadErrorHandlingPolicy loadErrorHandlingPolicy
)
```

Called when the `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSampleStream` encounters an error loading a chunk obtained from this source.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/Chunk chunk` | The chunk whose load encountered the error. |
| `boolean cancelable` | Whether the load can be canceled. |
| `https://developer.android.com/reference/androidx/media3/exoplayer/upstream/LoadErrorHandlingPolicy.LoadErrorInfo loadErrorInfo` | The load error info. |
| `https://developer.android.com/reference/androidx/media3/exoplayer/upstream/LoadErrorHandlingPolicy loadErrorHandlingPolicy` | The load error handling policy to customize the behaviour of handling the load error. |

| Returns |
|---|---|
| `boolean` | Whether the load should be canceled so that a replacement chunk can be loaded instead. Must be `false` if `cancelable` is `false`. If `true`, `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/ChunkSource#getNextChunk(androidx.media3.exoplayer.LoadingInfo,long,java.util.List<? extends androidx.media3.exoplayer.source.chunk.MediaChunk>,androidx.media3.exoplayer.source.chunk.ChunkHolder)` will be called to obtain the replacement chunk. |

### release

```
abstract void release()
```

Releases any held resources.

### shouldCancelLoad

```
abstract boolean shouldCancelLoad(
    long playbackPositionUs,
    Chunk loadingChunk,
    List<MediaChunk> queue
)
```

Returns whether an ongoing load of a chunk should be canceled.

| Parameters |
|---|---|
| `long playbackPositionUs` | The current playback position, in microseconds. |
| `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/Chunk loadingChunk` | The currently loading `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/Chunk`. |
| `https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/MediaChunk> queue` | The queue of buffered `https://developer.android.com/reference/androidx/media3/exoplayer/source/chunk/MediaChunk`. |

| Returns |
|---|---|
| `boolean` | Whether the ongoing load of `loadingChunk` should be canceled. |