MediaCodecRenderer

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
public abstract class MediaCodecRenderer extends BaseRenderer

java.lang.Object
↳	androidx.media3.exoplayer.BaseRenderer
	↳	androidx.media3.exoplayer.mediacodec.MediaCodecRenderer

Known direct subclasses

MediaCodecAudioRenderer, MediaCodecVideoRenderer

`MediaCodecAudioRenderer`	Decodes and renders audio using `MediaCodec` and an `AudioSink`.
`MediaCodecVideoRenderer`	Decodes and renders video using `MediaCodec`.

Known indirect subclasses

CapturingRenderersFactory.CapturingMediaCodecVideoRenderer

CapturingRenderersFactory.CapturingMediaCodecVideoRenderer

A MediaCodecVideoRenderer that will not skip or drop buffers due to slow processing.

An abstract renderer that uses MediaCodec to decode samples for rendering.

Summary

Nested types
`public class MediaCodecRenderer.DecoderInitializationException extends Exception` Thrown when a failure occurs instantiating a decoder.

Constants
`static final float`	`CODEC_OPERATING_RATE_UNSET = -1.0f` Indicates no codec operating rate should be set.

Protected fields
`@Nullable MediaCodecAdapter`	`codec`
`@Nullable MediaCodecInfo`	`codecInfo`
`boolean`	`codecNeedsEosPropagation`
`float`	`codecOperatingRate`
`@Nullable MediaFormat`	`codecOutputMediaFormat`
`DecoderCounters`	`decoderCounters`
`long`	`lastBufferInStreamPresentationTimeUs`
`@MonotonicNonNull Renderer.WakeupListener`	`@MonotonicNonNull wakeupListener`

Public constructors
`MediaCodecRenderer( @C.TrackType int trackType, MediaCodecAdapter.Factory codecAdapterFactory, MediaCodecSelector mediaCodecSelector, boolean enableDecoderFallback, float assumedMinimumCodecOperatingRate )`

Public methods
`void`	`experimentalEnableProcessedStreamChangedAtStart()` Enables the renderer to invoke `onProcessedStreamChange` on the first stream.
`final long`	`getDurationToProgressUs(long positionUs, long elapsedRealtimeUs)` Returns minimum amount of playback clock time that must pass in order for the `render` call to make progress.
`void`	`handleMessage( @Renderer.MessageType int messageType, @Nullable Object message )` Handles a message delivered to the target.
`boolean`	`isEnded()` Whether the renderer is ready for the `ExoPlayer` instance to transition to `STATE_ENDED`.
`boolean`	`isReady()` Whether the renderer is able to immediately render media from the current position.
`void`	`render(long positionUs, long elapsedRealtimeUs)` Incrementally renders the `SampleStream`.
`void`	`setPlaybackSpeed(float currentPlaybackSpeed, float targetPlaybackSpeed)` Indicates the playback speed to this renderer.
`void`	`setRenderTimeLimitMs(long renderTimeLimitMs)` Sets a limit on the time a single `render` call can spend draining and filling the decoder.
`final int`	`@RendererCapabilities.Capabilities supportsFormat(Format format)` Returns the extent to which the `Renderer` supports a given format.
`final int`	`@RendererCapabilities.AdaptiveSupport supportsMixedMimeTypeAdaptation()` Returns the extent to which the `Renderer` supports adapting between supported formats that have different MIME types.

Protected methods
`DecoderReuseEvaluation`	`canReuseCodec( MediaCodecInfo codecInfo, Format oldFormat, Format newFormat )` Evaluates whether the existing `MediaCodec` can be kept for a new `Format`, and if it can whether it requires reconfiguration.
`MediaCodecDecoderException`	`createDecoderException( Throwable cause, @Nullable MediaCodecInfo codecInfo )`
`final boolean`	`flushOrReinitializeCodec()` Flushes the codec.
`final @Nullable MediaCodecAdapter`	`getCodec()`
`int`	`getCodecBufferFlags(DecoderInputBuffer buffer)` Returns the flags that should be set on `queueInputBuffer` or `queueSecureInputBuffer` for this buffer.
`final @Nullable MediaCodecInfo`	`getCodecInfo()`
`boolean`	`getCodecNeedsEosPropagation()` Returns whether the codec needs the renderer to propagate the end-of-stream signal directly, rather than by using an end-of-stream buffer queued to the codec.
`float`	`getCodecOperatingRate()` Returns the operating rate used by the current codec
`float`	`getCodecOperatingRateV23( float targetPlaybackSpeed, Format format, Format[] streamFormats )` Returns the `KEY_OPERATING_RATE` value for a given playback speed, current `Format` and set of possible stream formats.
`final @Nullable MediaFormat`	`getCodecOutputMediaFormat()`
`abstract List<MediaCodecInfo>`	`getDecoderInfos( MediaCodecSelector mediaCodecSelector, Format format, boolean requiresSecureDecoder )` Returns a list of decoders that can decode media in the specified format, in priority order.
`long`	`getDurationToProgressUs( long positionUs, long elapsedRealtimeUs, boolean isOnBufferAvailableListenerRegistered )` Returns minimum time playback must advance in order for the `render` call to make progress.
`long`	`getLastBufferInStreamPresentationTimeUs()` Returns the presentation time of the last buffer in the stream.
`abstract MediaCodecAdapter.Configuration`	`getMediaCodecConfiguration( MediaCodecInfo codecInfo, Format format, @Nullable MediaCrypto crypto, float codecOperatingRate )` Returns the `MediaCodecAdapter.Configuration` that will be used to create and configure a `MediaCodec` to decode the given `Format` for a playback.
`final long`	`getOutputStreamOffsetUs()` Returns the offset that should be subtracted from `bufferPresentationTimeUs` in `processOutputBuffer` to get the playback position with respect to the media.
`final long`	`getOutputStreamStartPositionUs()` Returns the start position of the current output stream in microseconds.
`float`	`getPlaybackSpeed()` Returns the current playback speed, as set by `setPlaybackSpeed`.
`final @Nullable Renderer.WakeupListener`	`getWakeupListener()` Returns listener used to signal that `render` should be called.
`void`	`handleInputBufferSupplementalData(DecoderInputBuffer buffer)` Handles supplemental data associated with an input buffer.
`boolean`	`hasSkippedFlushAndWaitingForEarlierFrame()` Returns whether the renderer has skipped flushing the codec and is waiting to process an earlier frame.
`final boolean`	`isBypassEnabled()` Returns whether bypass is enabled by the renderer.
`final boolean`	`isBypassPossible(Format format)` Returns whether buffers in the input format can be processed without a codec.
`final void`	`maybeInitCodecOrBypass()`
`boolean`	`maybeInitializeProcessingPipeline(Format format)` Initializes the processing pipeline, if needed by the implementation.
`void`	`onCodecError(Exception codecError)` Called when a codec error has occurred.
`void`	`onCodecInitialized( String name, MediaCodecAdapter.Configuration configuration, long initializedTimestampMs, long initializationDurationMs )` Called when a `MediaCodec` has been created and configured.
`void`	`onCodecReleased(String name)` Called when a `MediaCodec` has been released.
`void`	`onDisabled()` Called when the renderer is disabled.
`void`	`onEnabled(boolean joining, boolean mayRenderStartOfStream)` Called when the renderer is enabled.
`@Nullable DecoderReuseEvaluation`	`@CallSuper onInputFormatChanged(FormatHolder formatHolder)` Called when a new `Format` is read from the upstream `MediaPeriod`.
`void`	`onOutputFormatChanged(Format format, @Nullable MediaFormat mediaFormat)` Called when one of the output formats changes.
`void`	`onOutputStreamOffsetUsChanged(long outputStreamOffsetUs)` Called after the output stream offset changes.
`void`	`onPositionReset(long positionUs, boolean joining)` Called when the position is reset.
`void`	`@CallSuper onProcessedOutputBuffer(long presentationTimeUs)` Called when an output buffer is successfully processed.
`void`	`onProcessedStreamChange()` Called after the last output buffer before a stream change has been processed.
`void`	`onQueueInputBuffer(DecoderInputBuffer buffer)` Called immediately before an input buffer is queued into the codec.
`void`	`onReset()` Called when the renderer is reset.
`void`	`onStarted()` Called when the renderer is started.
`void`	`onStopped()` Called when the renderer is stopped.
`void`	`onStreamChanged( Format[] formats, long startPositionUs, long offsetUs, MediaSource.MediaPeriodId mediaPeriodId )` Called when the renderer's stream has changed.
`abstract boolean`	`processOutputBuffer( long positionUs, long elapsedRealtimeUs, @Nullable MediaCodecAdapter codec, @Nullable ByteBuffer buffer, int bufferIndex, int bufferFlags, int sampleCount, long bufferPresentationTimeUs, boolean isDecodeOnlyBuffer, boolean isLastBuffer, Format format )` Processes an output media buffer.
`void`	`releaseCodec()`
`void`	`renderToEndOfStream()` Incrementally renders any remaining output.
`void`	`@CallSuper resetCodecStateForFlush()` Resets the renderer internal state after a codec flush.
`void`	`@CallSuper resetCodecStateForRelease()` Resets the renderer internal state after a codec release.
`final void`	`setPendingOutputEndOfStream()` Notifies the renderer that output end of stream is pending and should be handled on the next render.
`final void`	`setPendingPlaybackException(ExoPlaybackException exception)` Sets an exception to be re-thrown by render.
`boolean`	`shouldDiscardDecoderInputBuffer(DecoderInputBuffer buffer)` Returns whether the input buffer should be discarded before decoding.
`boolean`	`shouldFlushCodec()` Returns whether the codec should be flushed in cases such that the codec was not released.
`boolean`	`shouldInitCodec(MediaCodecInfo codecInfo)`
`boolean`	`shouldReinitCodec()` Returns whether the renderer needs to re-initialize the codec, possibly as a result of a change in device capabilities.
`boolean`	`shouldReleaseCodecInsteadOfFlushing()` Returns whether the codec should be released rather than flushed.
`boolean`	`shouldSkipDecoderInputBuffer(DecoderInputBuffer buffer)` Returns whether the input buffer should be skipped before the decoder.
`boolean`	`shouldUseBypass(Format format)` Returns whether buffers in the input format can be processed without a codec.
`abstract int`	`@RendererCapabilities.Capabilities supportsFormat(MediaCodecSelector mediaCodecSelector, Format format)` Returns the `Capabilities` for the given `Format`.
`static boolean`	`supportsFormatDrm(Format format)` Returns whether this renderer supports the given `Format's` DRM scheme.
`final boolean`	`updateCodecOperatingRate()` Updates the codec operating rate, or triggers codec release and re-initialization if a previously set operating rate needs to be cleared.
`final void`	`updateOutputFormatForTime(long presentationTimeUs)` Updates the output formats for the specified output buffer timestamp, calling `onOutputFormatChanged` if a change has occurred.

Inherited Constants

From androidx.media3.exoplayer.Renderer

`static final long`	`DEFAULT_DURATION_TO_PROGRESS_US = 10000` Default minimum duration that the playback clock must advance before `render` can make progress.
`static final long`	`DEFAULT_IDLE_DURATION_TO_PROGRESS_US = 1000000` Default duration to progress reported if the renderer does not need calls to `render` to progress, if it's in `STATE_ENABLED` and already `ready` or `ended`.
`static final int`	`MSG_CUSTOM_BASE = 10000` Applications or extensions may define custom `MSG_*` constants that can be passed to renderers.
`static final int`	`MSG_SET_AUDIO_ATTRIBUTES = 3` A type of a message that can be passed to an audio renderer via `createMessage`.
`static final int`	`MSG_SET_AUDIO_SESSION_ID = 10` The type of a message that can be passed to audio and video renderers via `createMessage`.
`static final int`	`MSG_SET_AUX_EFFECT_INFO = 6` A type of a message that can be passed to an audio renderer via `createMessage`.
`static final int`	`MSG_SET_CAMERA_MOTION_LISTENER = 8` The type of a message that can be passed to a camera motion renderer via `createMessage`.
`static final int`	`MSG_SET_CHANGE_FRAME_RATE_STRATEGY = 5` The type of a message that can be passed to a video renderer via `createMessage`.
`static final int`	`MSG_SET_IMAGE_OUTPUT = 15` The type of message that can be passed to an image renderer to set a desired image output.
`static final int`	`MSG_SET_PREFERRED_AUDIO_DEVICE = 12` The type of a message that can be passed to audio renderers via `createMessage`.
`static final int`	`MSG_SET_PRIORITY = 16` The type of message that can be passed to a renderer to set its priority.
`static final int`	`MSG_SET_SCALING_MODE = 4` The type of a message that can be passed to a `MediaCodec`-based video renderer via `createMessage`.
`static final int`	`MSG_SET_SCRUBBING_MODE = 18` The type of message that can be passed to a renderer to direct it to enable or disable scrubbing mode.
`static final int`	`MSG_SET_SKIP_SILENCE_ENABLED = 9` The type of a message that can be passed to an audio renderer via `createMessage`.
`static final int`	`MSG_SET_VIDEO_EFFECTS = 13` The type of a message that can be passed to a video renderer.
`static final int`	`MSG_SET_VIDEO_FRAME_METADATA_LISTENER = 7` The type of a message that can be passed to a video renderer via `createMessage`.
`static final int`	`MSG_SET_VIDEO_OUTPUT = 1` The type of a message that can be passed to a video renderer via `createMessage`.
`static final int`	`MSG_SET_VIDEO_OUTPUT_RESOLUTION = 14` The type of a message that can be passed to a video renderer to set the desired output resolution.
`static final int`	`MSG_SET_VOLUME = 2` A type of a message that can be passed to an audio renderer via `createMessage`.
`static final int`	`MSG_SET_WAKEUP_LISTENER = 11` The type of a message that can be passed to a `Renderer` via `createMessage`, to inform the renderer that it can schedule waking up another component.
`static final int`	`MSG_TRANSFER_RESOURCES = 17` The type of message that can be passed to a renderer to direct it to transfer relevant resources to another renderer.
`static final int`	`STATE_DISABLED = 0` The renderer is disabled.
`static final int`	`STATE_ENABLED = 1` The renderer is enabled but not started.
`static final int`	`STATE_STARTED = 2` The renderer is started.

From androidx.media3.exoplayer.RendererCapabilities

`static final int`	`ADAPTIVE_NOT_SEAMLESS = 8` The `Renderer` can adapt between formats, but may suffer a brief discontinuity (~50-100ms) when adaptation occurs.
`static final int`	`ADAPTIVE_NOT_SUPPORTED = 0` The `Renderer` does not support adaptation between formats.
`static final int`	`ADAPTIVE_SEAMLESS = 16` The `Renderer` can seamlessly adapt between formats.
`static final int`	`ADAPTIVE_SUPPORT_MASK = 24` A mask to apply to `Capabilities` to obtain the `AdaptiveSupport` only.
`static final int`	`AUDIO_OFFLOAD_GAPLESS_SUPPORTED = 1024` The renderer supports audio offload and gapless transitions with this format.
`static final int`	`AUDIO_OFFLOAD_NOT_SUPPORTED = 0` Audio offload is not supported with this format.
`static final int`	`AUDIO_OFFLOAD_SPEED_CHANGE_SUPPORTED = 2048` The renderer supports audio offload and speed changes with this format.
`static final int`	`AUDIO_OFFLOAD_SUPPORTED = 512` The renderer supports audio offload with this format.
`static final int`	`AUDIO_OFFLOAD_SUPPORT_MASK = 3584` A mask to apply to `Capabilities` to obtain `AudioOffloadSupport` only.
`static final int`	`DECODER_SUPPORT_FALLBACK = 0` The format exceeds the primary decoder's capabilities but is supported by fallback decoder
`static final int`	`DECODER_SUPPORT_FALLBACK_MIMETYPE = 256` The format's MIME type is unsupported and the renderer may use a decoder for a fallback MIME type.
`static final int`	`DECODER_SUPPORT_MASK = 384` A mask to apply to `Capabilities` to obtain `DecoderSupport` only.
`static final int`	`DECODER_SUPPORT_PRIMARY = 128` The renderer is able to use the primary decoder for the format's MIME type.
`static final int`	`FORMAT_SUPPORT_MASK = 7` A mask to apply to `Capabilities` to obtain the `C.FormatSupport` only.
`static final int`	`HARDWARE_ACCELERATION_NOT_SUPPORTED = 0` The renderer is not able to use hardware acceleration.
`static final int`	`HARDWARE_ACCELERATION_SUPPORTED = 64` The renderer is able to use hardware acceleration.
`static final int`	`HARDWARE_ACCELERATION_SUPPORT_MASK = 64` A mask to apply to `Capabilities` to obtain `HardwareAccelerationSupport` only.
`static final int`	`TUNNELING_NOT_SUPPORTED = 0` The `Renderer` does not support tunneled output.
`static final int`	`TUNNELING_SUPPORTED = 32` The `Renderer` supports tunneled output.
`static final int`	`TUNNELING_SUPPORT_MASK = 32` A mask to apply to `Capabilities` to obtain `TunnelingSupport` only.

Inherited fields

From androidx.media3.exoplayer.BaseRenderer

`@MonotonicNonNull Clock`	`@MonotonicNonNull clock`
`@Nullable RendererConfiguration`	`configuration`
`final FormatHolder`	`formatHolder`
`int`	`index`
`long`	`lastResetPositionUs`
`@Nullable MediaSource.MediaPeriodId`	`mediaPeriodId`
`@MonotonicNonNull PlayerId`	`@MonotonicNonNull playerId`
`long`	`readingPositionUs`
`int`	`state`
`@Nullable SampleStream`	`stream`
`@Nullable Format[]`	`streamFormats`
`long`	`streamOffsetUs`
`Timeline`	`timeline`
`final int`	`@C.TrackType trackType`

Inherited methods

From androidx.media3.exoplayer.BaseRenderer

`final void`	`clearListener()` Clears the `Listener`.
`final ExoPlaybackException`	`createRendererException( Throwable cause, @Nullable Format format, @PlaybackException.ErrorCode int errorCode )` Creates an `ExoPlaybackException` of type `TYPE_RENDERER` for this renderer.
`final`

MediaCodecRenderer

Summary

Nested types

Constants

Protected fields

Public constructors

Public methods

Protected methods

Inherited Constants

Inherited fields

Inherited methods