DecoderInputBuffer

Artifact: androidx.media3:media3-decoder

Kotlin |Java

@UnstableApi
public class DecoderInputBuffer extends Buffer

java.lang.Object
↳	androidx.media3.decoder.Buffer
	↳	androidx.media3.decoder.DecoderInputBuffer

Known direct subclasses

MetadataInputBuffer, SubtitleInputBuffer

`MetadataInputBuffer`	A `DecoderInputBuffer` for a `MetadataDecoder`.
`SubtitleInputBuffer`	A `DecoderInputBuffer` for a `SubtitleDecoder`.

Holds input for a decoder.

Summary

Nested types
`@Documented @Retention(value = RetentionPolicy.SOURCE) @Target(value = TYPE_USE) @IntDef(value = ) public annotation DecoderInputBuffer.BufferReplacementMode` The buffer replacement mode.
`public final class DecoderInputBuffer.InsufficientCapacityException extends IllegalStateException` Thrown when an attempt is made to write into a `DecoderInputBuffer` whose `bufferReplacementMode` is `BUFFER_REPLACEMENT_MODE_DISABLED` and who `data` capacity is smaller than required.

Constants
`static final int`	`BUFFER_REPLACEMENT_MODE_DIRECT = 2` Allows buffer replacement using `allocateDirect`.
`static final int`	`BUFFER_REPLACEMENT_MODE_DISABLED = 0` Disallows buffer replacement.
`static final int`	`BUFFER_REPLACEMENT_MODE_NORMAL = 1` Allows buffer replacement using `allocate`.

Public fields
`final CryptoInfo`	`cryptoInfo` `CryptoInfo` for encrypted data.
`@Nullable ByteBuffer`	`data` The buffer's data, or `null` if no data has been set.
`@Nullable Format`	`format` The `Format`.
`@Nullable ByteBuffer`	`supplementalData` Supplemental data related to the buffer, if `hasSupplementalData` returns true.
`long`	`timeUs` The time at which the sample should be presented.
`boolean`	`waitingForKeys` Whether the last attempt to read a sample into this buffer failed due to not yet having the DRM keys associated with the next sample.

Public constructors
`DecoderInputBuffer( @DecoderInputBuffer.BufferReplacementMode int bufferReplacementMode )` Creates a new instance.
`DecoderInputBuffer( @DecoderInputBuffer.BufferReplacementMode int bufferReplacementMode, int paddingSize )` Creates a new instance.

Public methods
`void`	`clear()` Clears the buffer.
`void`	`@EnsuresNonNull(value = "data") ensureSpaceForWrite(int length)` Ensures that `data` is large enough to accommodate a write of a given length at its current position.
`final void`	`flip()` Flips `data` and `supplementalData` in preparation for being queued to a decoder.
`final boolean`	`isEncrypted()` Returns whether the `BUFFER_FLAG_ENCRYPTED` flag is set.
`static DecoderInputBuffer`	`newNoDataInstance()` Returns a new instance that's not able to hold any data.
`void`	`@EnsuresNonNull(value = "supplementalData") resetSupplementalData(int length)` Clears `supplementalData` and ensures that it's large enough to accommodate `length` bytes.

Inherited methods

From androidx.media3.decoder.Buffer

`final void`	`addFlag(@C.BufferFlags int flag)` Adds the `flag` to this buffer's flags.
`final void`	`clearFlag(@C.BufferFlags int flag)` Removes the `flag` from this buffer's flags, if it is set.
`final boolean`	`getFlag(@C.BufferFlags int flag)` Returns whether the specified flag has been set on this buffer.
`final boolean`	`hasSupplementalData()` Returns whether the `BUFFER_FLAG_HAS_SUPPLEMENTAL_DATA` flag is set.
`final boolean`	`isDecodeOnly()` This method is deprecated. Check instead whether the buffer time is greater or equal to the desired start time.
`final boolean`	`isEndOfStream()` Returns whether the `BUFFER_FLAG_END_OF_STREAM` flag is set.
`final boolean`	`isFirstSample()` Returns whether the `BUFFER_FLAG_FIRST_SAMPLE` flag is set.
`final boolean`	`isKeyFrame()` Returns whether the `BUFFER_FLAG_KEY_FRAME` flag is set.
`final boolean`	`isLastSample()` Returns whether the `BUFFER_FLAG_LAST_SAMPLE` flag is set.
`final void`	`setFlags(@C.BufferFlags int flags)` Replaces this buffer's flags with `flags`.

Constants

BUFFER_REPLACEMENT_MODE_DIRECT

public static final int BUFFER_REPLACEMENT_MODE_DIRECT = 2

Allows buffer replacement using allocateDirect.

BUFFER_REPLACEMENT_MODE_DISABLED

public static final int BUFFER_REPLACEMENT_MODE_DISABLED = 0

Disallows buffer replacement.

BUFFER_REPLACEMENT_MODE_NORMAL

public static final int BUFFER_REPLACEMENT_MODE_NORMAL = 1

Allows buffer replacement using allocate.

Public fields

cryptoInfo

public final CryptoInfo cryptoInfo

CryptoInfo for encrypted data.

data

public @Nullable ByteBuffer data

The buffer's data, or null if no data has been set.

format

public @Nullable Format format

The Format.

supplementalData

public @Nullable ByteBuffer supplementalData

Supplemental data related to the buffer, if hasSupplementalData returns true. If present, the buffer is populated with supplemental data from position 0 to its limit.

timeUs

public long timeUs

The time at which the sample should be presented.

waitingForKeys

public boolean waitingForKeys

Whether the last attempt to read a sample into this buffer failed due to not yet having the DRM keys associated with the next sample.

Public constructors