BitmapFactoryImageDecoder

Kotlin |Java

@UnstableApi
class BitmapFactoryImageDecoder : SimpleDecoder, ImageDecoder

kotlin.Any
↳	androidx.media3.decoder.SimpleDecoder
	↳	androidx.media3.exoplayer.image.BitmapFactoryImageDecoder

An image decoder that uses BitmapFactory to decode images.

Only supports decoding one input buffer into one output buffer (i.e. one Bitmap alongside one timestamp)).

Summary

Nested types
`@VisibleForTesting(otherwise = 2) interface BitmapFactoryImageDecoder.BitmapDecoder` A functional interface for turning byte arrays into bitmaps.
`class BitmapFactoryImageDecoder.Factory : ImageDecoder.Factory` A factory for `BitmapFactoryImageDecoder` instances.

Public functions
`String!`	`getName()` Returns the name of the decoder.

Protected functions
`DecoderInputBuffer!`	`createInputBuffer()` Creates a new input buffer.
`ImageOutputBuffer!`	`createOutputBuffer()` Creates a new output buffer.
`ImageDecoderException!`	`createUnexpectedDecodeException(error: Throwable!)` Creates an exception to propagate for an unexpected decode error.
`ImageDecoderException?`	`decode( inputBuffer: DecoderInputBuffer!, outputBuffer: ImageOutputBuffer!, reset: Boolean )` Decodes the `inputBuffer` and stores any decoded output in `outputBuffer`.

`abstract ImageOutputBuffer?`	`dequeueOutputBuffer()` Returns the next decoded `Bitmap` in an `ImageOutputBuffer`.
`abstract Unit`	`queueInputBuffer(inputBuffer: DecoderInputBuffer!)` Queues an `DecoderInputBuffer` to the decoder.

`I?`	`dequeueInputBuffer()` Dequeues the next input buffer to be filled and queued to the decoder.
`O?`	`dequeueOutputBuffer()` Dequeues the next output buffer from the decoder.
`Unit`	`flush()` Flushes the decoder.
`Boolean`	`isAtLeastOutputStartTimeUs(timeUs: Long)` Returns whether a sample time is greater or equal to the `output start time`, if set.
`Unit`	`queueInputBuffer(inputBuffer: I!)` Queues an input buffer to the decoder.
`Unit`	`@CallSuper release()` Releases the decoder.
`Unit`	`@CallSuper releaseOutputBuffer(outputBuffer: O!)` Releases an output buffer back to the decoder.
`Unit`	`setInitialInputBufferSize(size: Int)` Sets the initial size of each input buffer.
`Unit`	`setOutputStartTimeUs(outputStartTimeUs: Long)` Sets the timestamp from which output buffers should be produced, in microseconds.

fun getName(): String!

Returns the name of the decoder.

Returns
`String!`	The name of the decoder.

protected fun createInputBuffer(): DecoderInputBuffer!

Creates a new input buffer.

protected fun createOutputBuffer(): ImageOutputBuffer!

Creates a new output buffer.

protected fun createUnexpectedDecodeException(error: Throwable!): ImageDecoderException!

Creates an exception to propagate for an unexpected decode error.

Parameters
`error: Throwable!`	The unexpected decode error.

Returns
`ImageDecoderException!`	The exception to propagate.

protected fun decode(
    inputBuffer: DecoderInputBuffer!,
    outputBuffer: ImageOutputBuffer!,
    reset: Boolean
): ImageDecoderException?

Decodes the inputBuffer and stores any decoded output in outputBuffer.

Parameters
`inputBuffer: DecoderInputBuffer!`	The buffer to decode.
`outputBuffer: ImageOutputBuffer!`	The output buffer to store decoded data. The output buffer will not be made available to dequeue if its `timeUs` is not `at least the output start time` or when it's marked with `shouldBeSkipped`. The output buffer may not have been populated in these cases.
`reset: Boolean`	Whether the decoder must be reset before decoding.

Returns
`ImageDecoderException?`	A decoder exception if an error occurred, or null if decoding was successful.