VideoDecoderOutputBuffer

Artifact: androidx.media3:media3-decoder

Kotlin |Java

@UnstableApi
class VideoDecoderOutputBuffer : DecoderOutputBuffer

kotlin.Any
↳	androidx.media3.decoder.Buffer
	↳	androidx.media3.decoder.DecoderOutputBuffer
		↳	androidx.media3.decoder.VideoDecoderOutputBuffer

Video decoder output buffer containing video frame data.

Summary

Constants
`const Int`	`COLORSPACE_BT2020 = 3`
`const Int`	`COLORSPACE_BT601 = 1`
`const Int`	`COLORSPACE_BT709 = 2`
`const Int`	`COLORSPACE_UNKNOWN = 0`

Public constructors
`VideoDecoderOutputBuffer( owner: DecoderOutputBuffer.Owner<VideoDecoderOutputBuffer!>! )` Creates VideoDecoderOutputBuffer.

Public functions
`Unit`	`init( timeUs: Long, @C.VideoOutputMode mode: Int, supplementalData: ByteBuffer? )` Initializes the buffer.
`Boolean`	`initForOffsetFrames( offset: Int, width: Int, height: Int, yStride: Int, uvStride: Int, colorspace: Int, alignedHeight: Int )`
`Unit`	`initForPrivateFrame(width: Int, height: Int)` Configures the buffer for the given frame dimensions when passing actual frame data via `decoderPrivate`.
`Boolean`	`initForYuvFrame( width: Int, height: Int, yStride: Int, uvStride: Int, colorspace: Int )` Resizes the buffer based on the given stride.
`Unit`	`release()` Releases the output buffer for reuse.

Public properties
`Int`	`colorspace`
`ByteBuffer?`	`data` RGB buffer for RGB mode.
`Long`	`decoderPrivate` Decoder private data.
`Format?`	`format` The format of the input from which this output buffer was decoded.
`Int`	`height`
`Int`	`@C.VideoOutputMode mode` Output mode.
`ByteBuffer?`	`supplementalData` Supplemental data related to the output frame, if `hasSupplementalData` returns true.
`Int`	`uvStride`
`Int`	`width`
`Int`	`yStride`
`Array<ByteBuffer!>?`	`yuvPlanes` YUV planes for YUV mode.
`IntArray<Int>?`	`yuvStrides`

Inherited functions

From androidx.media3.decoder.Buffer

`Unit`	`addFlag(@C.BufferFlags flag: Int)` Adds the `flag` to this buffer's flags.
`Unit`	`clearFlag(@C.BufferFlags flag: Int)` Removes the `flag` from this buffer's flags, if it is set.
`Boolean`	`getFlag(@C.BufferFlags flag: Int)` Returns whether the specified flag has been set on this buffer.
`Boolean`	`hasSupplementalData()` Returns whether the `BUFFER_FLAG_HAS_SUPPLEMENTAL_DATA` flag is set.
`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.
`Boolean`	`notDependedOn()` Returns whether the `BUFFER_FLAG_NOT_DEPENDED_ON` flag is set.
`Unit`	`setFlags(@C.BufferFlags flags: Int)` Replaces this buffer's flags with `flags`.

From androidx.media3.decoder.DecoderOutputBuffer

Unit

@CallSuper
clear()

Clears the buffer.

Inherited properties

From androidx.media3.decoder.DecoderOutputBuffer

`Boolean`	`shouldBeSkipped` Whether this buffer should be skipped, usually because the decoding process generated no data or invalid data.
`Int`	`skippedOutputBufferCount` The number of buffers immediately prior to this one that were skipped in the `Decoder`.
`Long`	`timeUs` The presentation timestamp for the buffer, in microseconds.

Constants

COLORSPACE_BT2020

const val COLORSPACE_BT2020 = 3: Int

COLORSPACE_BT601

const val COLORSPACE_BT601 = 1: Int

COLORSPACE_BT709

const val COLORSPACE_BT709 = 2: Int

COLORSPACE_UNKNOWN

const val COLORSPACE_UNKNOWN = 0: Int

Public constructors

VideoDecoderOutputBuffer

VideoDecoderOutputBuffer(
    owner: DecoderOutputBuffer.Owner<VideoDecoderOutputBuffer!>!
)

Creates VideoDecoderOutputBuffer.

Parameters
`owner: DecoderOutputBuffer.Owner<VideoDecoderOutputBuffer!>!`	Buffer owner.

Public functions

init

fun init(
    timeUs: Long,
    @C.VideoOutputMode mode: Int,
    supplementalData: ByteBuffer?
): Unit

Initializes the buffer.

Parameters
`timeUs: Long`	The presentation timestamp for the buffer, in microseconds.
`@C.VideoOutputMode mode: Int`	The output mode. One of `VIDEO_OUTPUT_MODE_NONE`, `VIDEO_OUTPUT_MODE_YUV` and `VIDEO_OUTPUT_MODE_SURFACE_YUV`.
`supplementalData: ByteBuffer?`	Supplemental data associated with the frame, or `null` if not present. It is safe to reuse the provided buffer after this method returns.

initForOffsetFrames

fun initForOffsetFrames(
    offset: Int,
    width: Int,
    height: Int,
    yStride: Int,
    uvStride: Int,
    colorspace: Int,
    alignedHeight: Int
): Boolean

initForPrivateFrame

fun initForPrivateFrame(width: Int, height: Int): Unit

Configures the buffer for the given frame dimensions when passing actual frame data via decoderPrivate. Called via JNI after decoding completes.

initForYuvFrame

fun initForYuvFrame(
    width: Int,
    height: Int,
    yStride: Int,
    uvStride: Int,
    colorspace: Int
): Boolean

Resizes the buffer based on the given stride. Called via JNI after decoding completes.

Returns
`Boolean`	Whether the buffer was resized successfully.

release

fun release(): Unit

Releases the output buffer for reuse. Must be called when the buffer is no longer needed.

Public properties

colorspace

val colorspace: Int

data

val data: ByteBuffer?

RGB buffer for RGB mode.

decoderPrivate

val decoderPrivate: Long

Decoder private data. Used from native code.

format

val format: Format?

The format of the input from which this output buffer was decoded.

height

val height: Int

mode

@C.VideoOutputMode
val mode: Int

Output mode.

supplementalData

val supplementalData: ByteBuffer?

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

uvStride

val uvStride: Int

width

val width: Int

yStride

val yStride: Int

yuvPlanes

val yuvPlanes: Array<ByteBuffer!>?

YUV planes for YUV mode.

yuvStrides

val yuvStrides: IntArray<Int>?