ContainerMediaChunk

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
public class ContainerMediaChunk extends BaseMediaChunk

java.lang.Object
↳	androidx.media3.exoplayer.source.chunk.Chunk
	↳	androidx.media3.exoplayer.source.chunk.MediaChunk
		↳	androidx.media3.exoplayer.source.chunk.BaseMediaChunk
			↳	androidx.media3.exoplayer.source.chunk.ContainerMediaChunk

A BaseMediaChunk that uses an Extractor to decode sample data.

Summary

Public fields
`long`	`nextLoadPosition`

Public constructors
`ContainerMediaChunk( DataSource dataSource, DataSpec dataSpec, Format trackFormat, @C.SelectionReason int trackSelectionReason, @Nullable Object trackSelectionData, long startTimeUs, long endTimeUs, long clippedStartTimeUs, long clippedEndTimeUs, long chunkIndex, int chunkCount, long sampleOffsetUs, ChunkExtractor chunkExtractor )`

Public methods
`final void`	`cancelLoad()` Cancels the load.
`long`	`getNextChunkIndex()` Returns the next chunk index or `INDEX_UNSET` if it is not known.
`final long`	`getNextLoadPosition()` Returns the next position to load in the chunk on a `load`.
`final boolean`	`isLoadCanceled()` Returns whether the current chunk's load has been canceled from `cancelLoad`.
`boolean`	`isLoadCompleted()` Returns whether the chunk has been fully loaded.
`final void`	`load()` Performs the load, returning on completion or cancellation.

Protected methods
`ChunkExtractor.TrackOutputProvider`	`getTrackOutputProvider(BaseMediaChunkOutput baseMediaChunkOutput)` Returns the `TrackOutputProvider` to be used by the wrapped extractor.
`void`	`@ForOverride onLoadEnded()` Method that is called to signal that a `load` has concluded.

Inherited fields

From androidx.media3.exoplayer.source.chunk.BaseMediaChunk

`final long`	`clippedEndTimeUs` The time from which output will end, or `TIME_UNSET` if output will end at the end of the chunk.
`final long`	`clippedStartTimeUs` The time from which output will begin, or `TIME_UNSET` if output will begin from the start of the chunk.
`@MonotonicNonNull BaseMediaChunkOutput`	`@MonotonicNonNull output`

From androidx.media3.exoplayer.source.chunk.Chunk

`final StatsDataSource`	`dataSource`
`final DataSpec`	`dataSpec` The `DataSpec` that defines the data to be loaded.
`final long`	`endTimeUs` The end time of the media contained by the chunk, or `TIME_UNSET` if the data being loaded does not contain media samples.
`final long`	`loadTaskId` Identifies the load task for this loadable.
`final long`	`startTimeUs` The start time of the media contained by the chunk, or `TIME_UNSET` if the data being loaded does not contain media samples.
`final Format`	`trackFormat` The format of the track to which this chunk belongs.
`final @Nullable Object`	`trackSelectionData` Optional data associated with the selection of the track to which this chunk belongs.
`final int`	`@C.SelectionReason trackSelectionReason` One of the `selection reasons` if the chunk belongs to a track.
`final int`	`@C.DataType type` The `data type` of the chunk.

From androidx.media3.exoplayer.source.chunk.MediaChunk

final long

chunkIndex

The chunk index, or INDEX_UNSET if it is not known.

Inherited methods

From androidx.media3.exoplayer.source.chunk.BaseMediaChunk

`final int`	`getFirstSampleIndex(int trackIndex)` Returns the index of the first sample in the specified track of the output that will originate from this chunk.
`final BaseMediaChunkOutput`	`getOutput()` Returns the output most recently passed to `init`.
`void`	`init(BaseMediaChunkOutput output)` Initializes the chunk for loading, setting the `BaseMediaChunkOutput` that will receive samples as they are loaded.

From androidx.media3.exoplayer.source.chunk.Chunk

`final long`	`bytesLoaded()` Returns the number of bytes that have been loaded.
`final long`	`getDurationUs()` Returns the duration of the chunk in microseconds.
`final Map<String, List<String>>`	`getResponseHeaders()` Returns the response headers associated with the last `open` call.
`final Uri`	`getUri()` Returns the `Uri` associated with the last `open` call.

Public fields

nextLoadPosition

public long nextLoadPosition

Public constructors

ContainerMediaChunk

public ContainerMediaChunk(
    DataSource dataSource,
    DataSpec dataSpec,
    Format trackFormat,
    @C.SelectionReason int trackSelectionReason,
    @Nullable Object trackSelectionData,
    long startTimeUs,
    long endTimeUs,
    long clippedStartTimeUs,
    long clippedEndTimeUs,
    long chunkIndex,
    int chunkCount,
    long sampleOffsetUs,
    ChunkExtractor chunkExtractor
)

Parameters
`DataSource dataSource`	The source from which the data should be loaded.
`DataSpec dataSpec`	Defines the data to be loaded.
`Format trackFormat`	See `trackFormat`.
`@C.SelectionReason int trackSelectionReason`	See `trackSelectionReason`.
`@Nullable Object trackSelectionData`	See `trackSelectionData`.
`long startTimeUs`	The start time of the media contained by the chunk, in microseconds.
`long endTimeUs`	The end time of the media contained by the chunk, in microseconds.
`long clippedStartTimeUs`	The time in the chunk from which output will begin, or `TIME_UNSET` to output from the start of the chunk.
`long clippedEndTimeUs`	The time in the chunk from which output will end, or `TIME_UNSET` to output to the end of the chunk.
`long chunkIndex`	The index of the chunk, or `INDEX_UNSET` if it is not known.
`int chunkCount`	The number of chunks in the underlying media that are spanned by this instance. Normally equal to one, but may be larger if multiple chunks as defined by the underlying media are being merged into a single load.
`long sampleOffsetUs`	An offset to add to the sample timestamps parsed by the extractor.
`ChunkExtractor chunkExtractor`	A wrapped extractor to use for parsing the data.

Public methods

cancelLoad

public final void cancelLoad()

Cancels the load.

Loadable implementations should ensure that a currently executing load call will exit reasonably quickly after this method is called. The load call may exit either by returning or by throwing an IOException.

If there is a currently executing load call, then the thread on which that call is being made will be interrupted immediately after the call to this method. Hence implementations do not need to (and should not attempt to) interrupt the loading thread themselves.

Although the loading thread will be interrupted, Loadable implementations should not use the interrupted status of the loading thread in load to determine whether the load has been canceled. This approach is not robust [Internal ref: b/79223737]. Instead, implementations should use their own flag to signal cancelation (for example, using AtomicBoolean).

getNextChunkIndex

public long getNextChunkIndex()

Returns the next chunk index or INDEX_UNSET if it is not known.

getNextLoadPosition

public final long getNextLoadPosition()

Returns the next position to load in the chunk on a load.

isLoadCanceled

public final boolean isLoadCanceled()

Returns whether the current chunk's load has been canceled from cancelLoad.

isLoadCompleted

public boolean isLoadCompleted()

Returns whether the chunk has been fully loaded.

load

public final void load()

Performs the load, returning on completion or cancellation.

Throws
`java.io.IOException`	If the input could not be loaded.

Protected methods

getTrackOutputProvider

protected ChunkExtractor.TrackOutputProvider getTrackOutputProvider(BaseMediaChunkOutput baseMediaChunkOutput)

Returns the TrackOutputProvider to be used by the wrapped extractor.

Parameters
`BaseMediaChunkOutput baseMediaChunkOutput`	The `BaseMediaChunkOutput` most recently passed to `init`.

Returns
`ChunkExtractor.TrackOutputProvider`	A `TrackOutputProvider` to be used by the wrapped extractor.

onLoadEnded

@ForOverride
protected void onLoadEnded()

Method that is called to signal that a load has concluded. This is called in both successful and error scenarios before the DataSource is closed.