DataChunk

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
public abstract class DataChunk extends Chunk

java.lang.Object
↳	androidx.media3.exoplayer.source.chunk.Chunk
	↳	androidx.media3.exoplayer.source.chunk.DataChunk

A base class for Chunk implementations where the data should be loaded into a byte[] before being consumed.

Summary

Public constructors
`DataChunk( DataSource dataSource, DataSpec dataSpec, @C.DataType int type, Format trackFormat, @C.SelectionReason int trackSelectionReason, @Nullable Object trackSelectionData, @Nullable byte[] data )`

Public methods
`final void`	`cancelLoad()` Cancels the load.
`byte[]`	`getDataHolder()` Returns the array in which the data is held.
`final void`	`load()` Performs the load, returning on completion or cancellation.

Protected methods
`abstract void`	`consume(byte[] data, int limit)` Called by `load`.

Inherited fields

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.

Inherited methods

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 constructors

DataChunk

public DataChunk(
    DataSource dataSource,
    DataSpec dataSpec,
    @C.DataType int type,
    Format trackFormat,
    @C.SelectionReason int trackSelectionReason,
    @Nullable Object trackSelectionData,
    @Nullable byte[] data
)

Parameters
`DataSource dataSource`	The source from which the data should be loaded.
`DataSpec dataSpec`	Defines the data to be loaded.
`@C.DataType int type`	See `type`.
`Format trackFormat`	See `trackFormat`.
`@C.SelectionReason int trackSelectionReason`	See `trackSelectionReason`.
`@Nullable Object trackSelectionData`	See `trackSelectionData`.
`@Nullable byte[] data`	An optional recycled array that can be used as a holder for 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).

getDataHolder

public byte[] getDataHolder()

Returns the array in which the data is held.

This method should be used for recycling the holder only, and not for reading the data.

Returns
`byte[]`	The array in which the data is held.

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

consume

protected abstract void consume(byte[] data, int limit)

Called by load. Implementations should override this method to consume the loaded data.

Parameters
`byte[] data`	An array containing the data.
`int limit`	The limit of the data.

Throws
`java.io.IOException`	If an error occurs consuming the loaded data.