BitmapFactoryImageDecoder

Kotlin |Java

@UnstableApi
public final class BitmapFactoryImageDecoder extends SimpleDecoder implements ImageDecoder

java.lang.Object
↳	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) public interface BitmapFactoryImageDecoder.BitmapDecoder` A functional interface for turning byte arrays into bitmaps.
`public final class BitmapFactoryImageDecoder.Factory implements ImageDecoder.Factory` A factory for `BitmapFactoryImageDecoder` instances.

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

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

`abstract @Nullable ImageOutputBuffer`	`dequeueOutputBuffer()` Returns the next decoded `Bitmap` in an `ImageOutputBuffer`.
`abstract void`	`queueInputBuffer(DecoderInputBuffer inputBuffer)` Queues an `DecoderInputBuffer` to the decoder.

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

public String getName()

Returns the name of the decoder.

Returns
`String`	The name of the decoder.

protected DecoderInputBuffer createInputBuffer()

Creates a new input buffer.

protected ImageOutputBuffer createOutputBuffer()

Creates a new output buffer.

protected ImageDecoderException createUnexpectedDecodeException(Throwable error)

Creates an exception to propagate for an unexpected decode error.

Parameters
`Throwable error`	The unexpected decode error.

Returns
`ImageDecoderException`	The exception to propagate.

protected @Nullable ImageDecoderException decode(
    DecoderInputBuffer inputBuffer,
    ImageOutputBuffer outputBuffer,
    boolean reset
)

Decodes the inputBuffer and stores any decoded output in outputBuffer.

Parameters
`DecoderInputBuffer inputBuffer`	The buffer to decode.
`ImageOutputBuffer outputBuffer`	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.
`boolean reset`	Whether the decoder must be reset before decoding.

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