Buffer

Kotlin |Java

@UnstableApi
abstract class Buffer

Known direct subclasses

`DecoderInputBuffer`	Holds input for a decoder.
`DecoderOutputBuffer`	Output buffer decoded by a `Decoder`.

Known indirect subclasses

`ImageOutputBuffer`	Output buffer for `ImageDecoder`s.
`MetadataInputBuffer`	A `DecoderInputBuffer` for a `MetadataDecoder`.
`SimpleDecoderOutputBuffer`	Buffer for `SimpleDecoder` output.
`SubtitleInputBuffer`	A `DecoderInputBuffer` for a `SubtitleDecoder`.
`SubtitleOutputBuffer`	Base class for `SubtitleDecoder` output buffers.
`VideoDecoderOutputBuffer`	Video decoder output buffer containing video frame data.

Base class for buffers with flags.

Summary

Public constructors
`Buffer()`

Public functions
`Unit`	`addFlag(@C.BufferFlags flag: Int)` Adds the `flag` to this buffer's flags.
`Unit`	`@CallSuper clear()` Clears the buffer.
`Unit`	`clearFlag(@C.BufferFlags flag: Int)` Removes the `flag` from this buffer's flags, if it is set.
`Boolean`	`hasSupplementalData()` Returns whether the `BUFFER_FLAG_HAS_SUPPLEMENTAL_DATA` flag is set.
`Boolean`	`isDecodeOnly()` This function is deprecated. Check instead whether the buffer time is greater or equal to the desired start time.
`Boolean`	`isEndOfStream()` Returns whether the `BUFFER_FLAG_END_OF_STREAM` flag is set.
`Boolean`	`isFirstSample()` Returns whether the `BUFFER_FLAG_FIRST_SAMPLE` flag is set.
`Boolean`	`isKeyFrame()` Returns whether the `BUFFER_FLAG_KEY_FRAME` flag is set.
`Boolean`	`isLastSample()` Returns whether the `BUFFER_FLAG_LAST_SAMPLE` flag is set.
`Unit`	`setFlags(@C.BufferFlags flags: Int)` Replaces this buffer's flags with `flags`.

Protected functions
`Boolean`	`getFlag(@C.BufferFlags flag: Int)` Returns whether the specified flag has been set on this buffer.

Buffer()

fun addFlag(@C.BufferFlags flag: Int): Unit

Adds the flag to this buffer's flags.

Parameters
`@C.BufferFlags flag: Int`	The flag to add to this buffer's flags, which should be one of the `C.BUFFER_FLAG_*` constants.

@CallSuper
fun clear(): Unit

Clears the buffer.

fun clearFlag(@C.BufferFlags flag: Int): Unit

Removes the flag from this buffer's flags, if it is set.

Parameters
`@C.BufferFlags flag: Int`	The flag to remove.

fun hasSupplementalData(): Boolean

Returns whether the BUFFER_FLAG_HAS_SUPPLEMENTAL_DATA flag is set.

fun isDecodeOnly(): Boolean

fun isEndOfStream(): Boolean

Returns whether the BUFFER_FLAG_END_OF_STREAM flag is set.

If this is set, all other attributes of the buffer should be ignored.

fun isFirstSample(): Boolean

Returns whether the BUFFER_FLAG_FIRST_SAMPLE flag is set.

fun isKeyFrame(): Boolean

Returns whether the BUFFER_FLAG_KEY_FRAME flag is set.

fun isLastSample(): Boolean

Returns whether the BUFFER_FLAG_LAST_SAMPLE flag is set.

fun setFlags(@C.BufferFlags flags: Int): Unit

Replaces this buffer's flags with flags.

Parameters
`@C.BufferFlags flags: Int`	The flags to set, which should be a combination of the `C.BUFFER_FLAG_*` constants.

protected fun getFlag(@C.BufferFlags flag: Int): Boolean

Returns whether the specified flag has been set on this buffer.

Parameters
`@C.BufferFlags flag: Int`	The flag to check.

Returns
`Boolean`	Whether the flag is set.