MediaCodecVideoRenderer

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
public class MediaCodecVideoRenderer extends MediaCodecRenderer implements VideoFrameReleaseControl.FrameTimingEvaluator

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

Decodes and renders video using MediaCodec.

This renderer accepts the following messages sent via createMessage on the playback thread:

Message with type MSG_SET_VIDEO_OUTPUT to set the output. The message payload should be the target Surface, or null to clear the output. Other non-null payloads have the effect of clearing the output.
Message with type MSG_SET_VIDEO_OUTPUT_RESOLUTION to set the output resolution. The message payload should be the output resolution in Size.
Message with type MSG_SET_SCALING_MODE to set the video scaling mode. The message payload should be one of the integer scaling modes in C.VideoScalingMode. Note that the scaling mode only applies if the Surface targeted by this renderer is owned by a android.view.SurfaceView.
Message with type MSG_SET_CHANGE_FRAME_RATE_STRATEGY to set the strategy used to call setFrameRate.
Message with type MSG_SET_VIDEO_FRAME_METADATA_LISTENER to set a listener for metadata associated with frames being rendered. The message payload should be the , or null.

Summary

Nested types
`public final class MediaCodecVideoRenderer.Builder` A builder to create `MediaCodecVideoRenderer` instances.
`protected final class MediaCodecVideoRenderer.CodecMaxValues`

Public constructors
`MediaCodecVideoRenderer( Context context, MediaCodecSelector mediaCodecSelector )` This method is deprecated. Use `Builder` instead.
`MediaCodecVideoRenderer( Context context, MediaCodecSelector mediaCodecSelector, long allowedJoiningTimeMs )` This method is deprecated. Use `Builder` instead.
`MediaCodecVideoRenderer( Context context, MediaCodecSelector mediaCodecSelector, long allowedJoiningTimeMs, @Nullable Handler eventHandler, @Nullable VideoRendererEventListener eventListener, int maxDroppedFramesToNotify )` This method is deprecated. Use `Builder` instead.
`MediaCodecVideoRenderer( Context context, MediaCodecSelector mediaCodecSelector, long allowedJoiningTimeMs, boolean enableDecoderFallback, @Nullable Handler eventHandler, @Nullable VideoRendererEventListener eventListener, int maxDroppedFramesToNotify )` This method is deprecated. Use `Builder` instead.
`MediaCodecVideoRenderer( Context context, MediaCodecAdapter.Factory codecAdapterFactory, MediaCodecSelector mediaCodecSelector, long allowedJoiningTimeMs, boolean enableDecoderFallback, @Nullable Handler eventHandler, @Nullable VideoRendererEventListener eventListener, int maxDroppedFramesToNotify )` This method is deprecated. Use `Builder` instead.
`MediaCodecVideoRenderer( Context context, MediaCodecAdapter.Factory codecAdapterFactory, MediaCodecSelector mediaCodecSelector, long allowedJoiningTimeMs, boolean enableDecoderFallback, @Nullable Handler eventHandler, @Nullable VideoRendererEventListener eventListener, int maxDroppedFramesToNotify, float assumedMinimumCodecOperatingRate )` This method is deprecated. Use `Builder` instead.
`MediaCodecVideoRenderer( Context context, MediaCodecAdapter.Factory codecAdapterFactory, MediaCodecSelector mediaCodecSelector, long allowedJoiningTimeMs, boolean enableDecoderFallback, @Nullable Handler eventHandler, @Nullable VideoRendererEventListener eventListener, int maxDroppedFramesToNotify, float assumedMinimumCodecOperatingRate, @Nullable VideoSinkProvider videoSinkProvider )` This method is deprecated. Use `Builder` instead.
`MediaCodecVideoRenderer( Context context, MediaCodecAdapter.Factory codecAdapterFactory, MediaCodecSelector mediaCodecSelector, long allowedJoiningTimeMs, boolean enableDecoderFallback, @Nullable Handler eventHandler, @Nullable VideoRendererEventListener eventListener, int maxDroppedFramesToNotify, float assumedMinimumCodecOperatingRate, @Nullable VideoSink videoSink )` This method is deprecated. Use `Builder` instead.

Public constructors

MediaCodecVideoRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector
)

This method is deprecated.

Use Builder instead.

MediaCodecVideoRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs
)

This method is deprecated.

Use Builder instead.

MediaCodecVideoRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify
)

This method is deprecated.

Use Builder instead.

MediaCodecVideoRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify
)

This method is deprecated.

Use Builder instead.

MediaCodecVideoRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify
)

This method is deprecated.

Use Builder instead.

MediaCodecVideoRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify,
    float assumedMinimumCodecOperatingRate
)

This method is deprecated.

Use Builder instead.

MediaCodecVideoRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify,
    float assumedMinimumCodecOperatingRate,
    @Nullable VideoSinkProvider videoSinkProvider
)

This method is deprecated.

Use Builder instead.

MediaCodecVideoRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify,
    float assumedMinimumCodecOperatingRate,
    @Nullable VideoSink videoSink
)

This method is deprecated.

Use Builder instead.

Protected constructors
`MediaCodecVideoRenderer(MediaCodecVideoRenderer.Builder builder)`

Public methods
`void`	`enableMayRenderStartOfStream()` Enables this renderer to render the start of the stream even if the state is not `STATE_STARTED` yet.
`static int`	`getCodecMaxInputSize(MediaCodecInfo codecInfo, Format format)` Returns a maximum input size for a given codec and format.
`String`	`getName()` Returns the name of this renderer, for logging and debugging purposes.
`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`	`@CallSuper render(long positionUs, long elapsedRealtimeUs)` Incrementally renders the `SampleStream`.
`void`	`setPlaybackSpeed(float currentPlaybackSpeed, float targetPlaybackSpeed)` Indicates the playback speed to this renderer.
`void`	`setVideoEffects(List<Effect> effects)` Sets the `video effects` to apply.
`boolean`	`shouldDropFrame( long earlyUs, long elapsedRealtimeUs, boolean isLastFrame )` Returns whether the frame should be dropped.
`boolean`	`shouldForceReleaseFrame(long earlyUs, long elapsedSinceLastReleaseUs)` Whether a frame should be forced for release.
`boolean`	`shouldIgnoreFrame( long earlyUs, long positionUs, long elapsedRealtimeUs, boolean isLastFrame, boolean treatDroppedBuffersAsSkipped )` Returns whether this frame should be ignored.
`static int`	`@RendererCapabilities.Capabilities supportsFormat( Context context, MediaCodecSelector mediaCodecSelector, Format format )` Returns the `Capabilities` of MediaCodecVideoRenderer for a given `Format`.

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.
`void`	`changeVideoSinkInputStream( VideoSink videoSink, @VideoSink.InputType int inputType, Format format )` Called when ready to `<>change` the input stream.
`boolean`	`codecNeedsSetOutputSurfaceWorkaround(String name)` Returns whether the codec is known to implement `setOutputSurface` incorrectly.
`MediaCodecDecoderException`	`createDecoderException( Throwable cause, @Nullable MediaCodecInfo codecInfo )`
`void`	`@RequiresApi(value = 35) detachOutputSurfaceV35(MediaCodecAdapter codec)`
`void`	`dropOutputBuffer( MediaCodecAdapter codec, int index, long presentationTimeUs )` Drops the output buffer with the specified index.
`long`	`getBufferTimestampAdjustmentUs()` Returns the timestamp that is added to the buffer presentation time (the player decoding position) to get the frame presentation time, in microseconds.
`int`	`getCodecBufferFlags(DecoderInputBuffer buffer)` Returns the flags that should be set on `queueInputBuffer` or `queueSecureInputBuffer` for this buffer.
`MediaCodecVideoRenderer.CodecMaxValues`	`getCodecMaxValues( MediaCodecInfo codecInfo, Format format, Format[] streamFormats )` Returns `CodecMaxValues` suitable for configuring a codec for `format` in a way that will allow possible adaptation to other compatible formats in `streamFormats`.
`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`	`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.
`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.
`static int`	`getMaxInputSize(MediaCodecInfo codecInfo, Format format)` Returns a maximum input buffer size for a given `MediaCodec` and `Format`.
`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.
`MediaFormat`	`getMediaFormat( Format format, String codecMimeType, MediaCodecVideoRenderer.CodecMaxValues codecMaxValues, float codecOperatingRate, boolean deviceNeedsNoPostProcessWorkaround, int tunnelingAudioSessionId )` Returns the framework `MediaFormat` that should be used to configure the decoder.
`@Nullable Surface`	`getSurface()` Returns the output surface.
`void`	`@TargetApi(value = 29) handleInputBufferSupplementalData(DecoderInputBuffer buffer)` Handles supplemental data associated with an input buffer.
`boolean`	`maybeDropBuffersToKeyframe( long positionUs, boolean treatDroppedBuffersAsSkipped )` Drops frames from the current output buffer to the next keyframe at or before the playback position.
`boolean`	`@CallSuper 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.
`void`	`onInit()` Called when the renderer is initialized.
`@Nullable DecoderReuseEvaluation`	`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`	`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`	`onProcessedTunneledBuffer(long presentationTimeUs)` Called when a buffer was processed in tunneling mode.
`void`	`@CallSuper onQueueInputBuffer(DecoderInputBuffer buffer)` Called immediately before an input buffer is queued into the codec.
`void`	`onRelease()` Called when the renderer is released.
`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.
`void`	`onWakeupListenerSet(Renderer.WakeupListener wakeupListener)` Called when a `WakeupListener` is set.
`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`	`renderOutputBuffer( MediaCodecAdapter codec, int index, long presentationTimeUs )` This method is deprecated. Override `renderOutputBufferV21` instead.
`void`	`renderOutputBufferV21( MediaCodecAdapter codec, int index, long presentationTimeUs, long releaseTimeNs )` Renders the output buffer with the specified index.
`void`	`renderToEndOfStream()` Incrementally renders any remaining output.
`void`	`@CallSuper resetCodecStateForFlush()` Resets the renderer internal state after a codec flush.
`void`	`@RequiresApi(value = 23) setOutputSurfaceV23(MediaCodecAdapter codec, Surface surface)`
`boolean`	`shouldDiscardDecoderInputBuffer(DecoderInputBuffer buffer)` Returns whether the input buffer should be discarded before decoding.
`boolean`	`shouldDropBuffersToKeyframe( long earlyUs, long elapsedRealtimeUs, boolean isLastBuffer )` Returns whether to drop all buffers from the buffer being processed to the keyframe at or after the current playback position, if possible.
`boolean`	`shouldDropOutputBuffer( long earlyUs, long elapsedRealtimeUs, boolean isLastBuffer )` Returns whether the buffer being processed should be dropped.
`boolean`	`shouldForceRenderOutputBuffer( long earlyUs, long elapsedSinceLastRenderUs )` Returns whether to force rendering an output buffer.
`boolean`	`shouldInitCodec(MediaCodecInfo codecInfo)`
`boolean`	`shouldSkipBuffersWithIdenticalReleaseTime()` Returns whether to skip buffers that have an identical release time as the previous released buffer.
`boolean`	`shouldUseDetachedSurface(MediaCodecInfo codecInfo)`
`boolean`	`shouldUsePlaceholderSurface(MediaCodecInfo codecInfo)`
`void`	`skipOutputBuffer( MediaCodecAdapter codec, int index, long presentationTimeUs )` Skips the output buffer with the specified index.
`int`	`@RendererCapabilities.Capabilities supportsFormat(MediaCodecSelector mediaCodecSelector, Format format)` Returns the `Capabilities` for the given `Format`.
`void`	`updateDroppedBufferCounters( int droppedInputBufferCount, int droppedDecoderBufferCount )` Updates local counters and `decoderCounters` to reflect that buffers were dropped.
`void`	`updateVideoFrameProcessingOffsetCounters(long processingOffsetUs)` Updates local counters and `DecoderCounters` with a new video frame processing offset.

Inherited Constants

From androidx.media3.exoplayer.mediacodec.MediaCodecRenderer

static final float

CODEC_OPERATING_RATE_UNSET = -1.0f

Indicates no codec operating rate should be set.

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 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_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`
`@MonotonicNonNull PlayerId`	`@MonotonicNonNull playerId`
`long`	`readingPositionUs`
`int`	`state`
`@Nullable SampleStream`	`stream`
`@Nullable Format[]`	`streamFormats`
`long`	`streamOffsetUs`
`Timeline`	`timeline`
`final int`	`@C.TrackType trackType`

From androidx.media3.exoplayer.mediacodec.MediaCodecRenderer

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

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 ExoPlaybackException`	`createRendererException( Throwable cause, @Nullable Format format, boolean isRecoverable, @PlaybackException.ErrorCode int errorCode )` Creates an `ExoPlaybackException` of type `TYPE_RENDERER` for this renderer.
`final void`	`disable()` Disable the renderer, transitioning it to the `STATE_DISABLED` state.
`final void`	`enable( RendererConfiguration configuration, Format[] formats, SampleStream stream, long positionUs, boolean joining, boolean mayRenderStartOfStream, long startPositionUs, long offsetUs, MediaSource.MediaPeriodId mediaPeriodId )` Enables the renderer to consume from the specified `SampleStream`.
`final RendererCapabilities`	`getCapabilities()` Returns the capabilities of the renderer.
`final Clock`	`getClock()` Returns the `Clock`.
`final RendererConfiguration`	`getConfiguration()` Returns the configuration set when the renderer was most recently enabled.
`final FormatHolder`	`getFormatHolder()` Returns a clear `FormatHolder`.
`final int`	`getIndex()` Returns the index of the renderer within the player.
`final long`	`getLastResetPositionUs()` Returns the position passed to the most recent call to `enable` or resetPosition.
`@Nullable MediaClock`	`getMediaClock()` If the renderer advances its own playback position then this method returns a corresponding `MediaClock`.
`final PlayerId`	`getPlayerId()` Returns the `PlayerId` of the player using this renderer.
`final long`	`getReadingPositionUs()` Returns the renderer time up to which the renderer has read samples, in microseconds, or `TIME_END_OF_SOURCE` if the renderer has read the current `SampleStream` to the end.
`final int`	`getState()` Returns the current state of the renderer.
`final @Nullable SampleStream`	`getStream()` Returns the `SampleStream` being consumed, or null if the renderer is disabled.
`final Format[]`	`getStreamFormats()` Returns the formats of the currently enabled stream.
`final long`	`getStreamOffsetUs()` Returns the offset added to timestamps of buffers read from the `SampleStream`.
`final Timeline`	`getTimeline()` Returns the current `Timeline` containing the rendered stream.
`final int`	`@C.TrackType getTrackType()` Returns the track type that the renderer handles.
`final boolean`	`hasReadStreamToEnd()` Returns whether the renderer has read the current `SampleStream` to the end.
`final void`	`init(int index, PlayerId playerId, Clock clock)` Initializes the renderer for playback with a player.
`final boolean`	`isCurrentStreamFinal()` Returns whether the current `SampleStream` will be the final one supplied before the renderer is next disabled or reset.
`final boolean`	`isSourceReady()` Returns whether the upstream source is ready.
`final void`	`maybeThrowStreamError()` Throws an error that's preventing the renderer from reading from its `SampleStream`.
`final void`	`onRendererCapabilitiesChanged()` Called when the renderer capabilities are changed.
`void`	`onTimelineChanged(Timeline timeline)` Called when a new timeline is `set`.
`final int`	`@SampleStream.ReadDataResult readSource( FormatHolder formatHolder, DecoderInputBuffer buffer, @SampleStream.ReadFlags int readFlags )` Reads from the enabled upstream source.
`final void`	`release()` Releases the renderer.
`final void`	`replaceStream( Format[] formats, SampleStream stream, long startPositionUs, long offsetUs, MediaSource.MediaPeriodId mediaPeriodId )` Replaces the `SampleStream` from which samples will be consumed.
`final void`	`reset()` Forces the renderer to give up any resources (e.g. media decoders) that it may be holding.
`final void`	`resetPosition(long positionUs)` Signals to the renderer that a position discontinuity has occurred.
`final void`	`setCurrentStreamFinal()` Signals to the renderer that the current `SampleStream` will be the final one supplied before it is next disabled or reset.
`final void`	`setListener(RendererCapabilities.Listener listener)` Sets the `Listener`.
`final void`	`setTimeline(Timeline timeline)` Sets the timeline that is currently being played.
`int`	`skipSource(long positionUs)` Attempts to skip to the keyframe before the specified position, or to the end of the stream if `positionUs` is beyond it.
`final void`	`start()` Starts the renderer, meaning that calls to `render` will cause media to be rendered.
`final void`	`stop()` Stops the renderer, transitioning it to the `STATE_ENABLED` state.

From androidx.media3.exoplayer.mediacodec.MediaCodecRenderer

`void`	`experimentalEnableProcessedStreamChangedAtStart()` Enables the renderer to invoke `onProcessedStreamChange` on the first stream.
`final boolean`	`flushOrReinitializeCodec()` Flushes the codec.
`boolean`	`flushOrReleaseCodec()` Flushes the codec.
`final @Nullable MediaCodecAdapter`	`getCodec()`
`final @Nullable MediaCodecInfo`	`getCodecInfo()`
`float`	`getCodecOperatingRate()` Returns the operating rate used by the current codec
`final @Nullable MediaFormat`	`getCodecOutputMediaFormat()`
`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.
`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.
`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.
`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()`
`void`	`onOutputStreamOffsetUsChanged(long outputStreamOffsetUs)` Called after the output stream offset changes.
`void`	`releaseCodec()`
`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.
`void`	`setRenderTimeLimitMs(long renderTimeLimitMs)` Sets a limit on the time a single `render` call can spend draining and filling the decoder.
`boolean`	`shouldReinitCodec()` Returns whether the renderer needs to re-initialize the codec, possibly as a result of a change in device capabilities.
`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.
`final int`	`@RendererCapabilities.Capabilities supportsFormat(Format format)` Returns the extent to which the `Renderer` supports a given format.
`static boolean`	`supportsFormatDrm(Format format)` Returns whether this renderer supports the given `Format's` DRM scheme.
`final int`	`@RendererCapabilities.AdaptiveSupport supportsMixedMimeTypeAdaptation()` Returns the extent to which the `Renderer` supports adapting between supported formats that have different MIME types.
`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.

From androidx.media3.exoplayer.Renderer

`abstract void`	`enable( RendererConfiguration configuration, Format[] formats, SampleStream stream, long positionUs, boolean joining, boolean mayRenderStartOfStream, long startPositionUs, long offsetUs, MediaSource.MediaPeriodId mediaPeriodId )` Enables the renderer to consume from the specified `SampleStream`.
`abstract void`	`replaceStream( Format[] formats, SampleStream stream, long startPositionUs, long offsetUs, MediaSource.MediaPeriodId mediaPeriodId )` Replaces the `SampleStream` from which samples will be consumed.

From androidx.media3.exoplayer.RendererCapabilities

`static int`	`@RendererCapabilities.Capabilities create(@C.FormatSupport int formatSupport)` Returns `Capabilities` for the given `C.FormatSupport`.
`static int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport int formatSupport, @RendererCapabilities.AdaptiveSupport int adaptiveSupport, @RendererCapabilities.TunnelingSupport int tunnelingSupport )` Returns `Capabilities` combining the given `C.FormatSupport`, and `TunnelingSupport`.
`static int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport int formatSupport, @RendererCapabilities.AdaptiveSupport int adaptiveSupport, @RendererCapabilities.TunnelingSupport int tunnelingSupport, @RendererCapabilities.AudioOffloadSupport int audioOffloadSupport )` Returns `Capabilities` combining the given `C.FormatSupport`, , `TunnelingSupport`, and `AudioOffloadSupport`.
`static int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport int formatSupport, @RendererCapabilities.AdaptiveSupport int adaptiveSupport, @RendererCapabilities.TunnelingSupport int tunnelingSupport, @RendererCapabilities.HardwareAccelerationSupport int hardwareAccelerationSupport, @RendererCapabilities.DecoderSupport int decoderSupport )` Returns `Capabilities` combining the given `C.FormatSupport`, , `TunnelingSupport`, `HardwareAccelerationSupport`, and .
`static int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport int formatSupport, @RendererCapabilities.AdaptiveSupport int adaptiveSupport, @RendererCapabilities.TunnelingSupport int tunnelingSupport, @RendererCapabilities.HardwareAccelerationSupport int hardwareAccelerationSupport, @RendererCapabilities.DecoderSupport int decoderSupport, @RendererCapabilities.AudioOffloadSupport int audioOffloadSupport )` Returns `Capabilities` combining the given `C.FormatSupport`, , `TunnelingSupport`, `HardwareAccelerationSupport`, and `AudioOffloadSupport`.
`static int`	`@RendererCapabilities.AdaptiveSupport getAdaptiveSupport(@RendererCapabilities.Capabilities int supportFlags)` Returns the `AdaptiveSupport` from the combined `Capabilities`.
`static int`	`@RendererCapabilities.AudioOffloadSupport getAudioOffloadSupport( @RendererCapabilities.Capabilities int supportFlags )` Returns the `AudioOffloadSupport` from the combined `Capabilities`.
`static int`	`@RendererCapabilities.DecoderSupport getDecoderSupport(@RendererCapabilities.Capabilities int supportFlags)` Returns the `DecoderSupport` from the combined `Capabilities`.
`static int`	`@C.FormatSupport getFormatSupport(@RendererCapabilities.Capabilities int supportFlags)` Returns the `C.FormatSupport` from the combined `Capabilities`.
`static int`	`@RendererCapabilities.HardwareAccelerationSupport getHardwareAccelerationSupport( @RendererCapabilities.Capabilities int supportFlags )` Returns the `HardwareAccelerationSupport` from the combined `Capabilities`.
`static int`	`@RendererCapabilities.TunnelingSupport getTunnelingSupport(@RendererCapabilities.Capabilities int supportFlags)` Returns the `TunnelingSupport` from the combined `Capabilities`.
`static boolean`	`isFormatSupported( @RendererCapabilities.Capabilities int supportFlags, boolean allowExceedsCapabilities )` Returns whether the `C.FormatSupport` from the combined `Capabilities` indicates the format is supported.
`void`	`setListener(RendererCapabilities.Listener listener)` Sets the `Listener`.

Public constructors

MediaCodecVideoRenderer

public MediaCodecVideoRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector
)

MediaCodecVideoRenderer

public MediaCodecVideoRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs
)

MediaCodecVideoRenderer

public MediaCodecVideoRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify
)

MediaCodecVideoRenderer

public MediaCodecVideoRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify
)

MediaCodecVideoRenderer

public MediaCodecVideoRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify
)

MediaCodecVideoRenderer

public MediaCodecVideoRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify,
    float assumedMinimumCodecOperatingRate
)

MediaCodecVideoRenderer

public MediaCodecVideoRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify,
    float assumedMinimumCodecOperatingRate,
    @Nullable VideoSinkProvider videoSinkProvider
)

MediaCodecVideoRenderer

public MediaCodecVideoRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    long allowedJoiningTimeMs,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable VideoRendererEventListener eventListener,
    int maxDroppedFramesToNotify,
    float assumedMinimumCodecOperatingRate,
    @Nullable VideoSink videoSink
)

Protected constructors

MediaCodecVideoRenderer

protected MediaCodecVideoRenderer(MediaCodecVideoRenderer.Builder builder)

Parameters
`MediaCodecVideoRenderer.Builder builder`	The `Builder` containing construction parameters.

Public methods

enableMayRenderStartOfStream

public void enableMayRenderStartOfStream()

Enables this renderer to render the start of the stream even if the state is not STATE_STARTED yet.

This is used to update the value of mayRenderStartOfStream passed to enable.

getCodecMaxInputSize

public static int getCodecMaxInputSize(MediaCodecInfo codecInfo, Format format)

Returns a maximum input size for a given codec and format.

Parameters
`MediaCodecInfo codecInfo`	Information about the `MediaCodec` being configured.
`Format format`	The format.

Returns
`int`	A maximum input size in bytes, or `NO_VALUE` if a maximum could not be determined.

getName

public String getName()

Returns the name of this renderer, for logging and debugging purposes. Should typically be the renderer's (un-obfuscated) class name.

Returns
`String`	The name of this renderer.

handleMessage

public void handleMessage(
    @Renderer.MessageType int messageType,
    @Nullable Object message
)

Handles a message delivered to the target.

Parameters
`@Renderer.MessageType int messageType`	The message type.
`@Nullable Object message`	The message payload.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurred whilst handling the message. Should only be thrown by targets that handle messages on the playback thread.

isEnded

public boolean isEnded()

Whether the renderer is ready for the ExoPlayer instance to transition to STATE_ENDED. The player will make this transition as soon as true is returned by all of its renderers.

This method may be called when the renderer is in the following states: STATE_ENABLED, STATE_STARTED.

Returns
`boolean`	Whether the renderer is ready for the player to transition to the ended state.

isReady

public boolean isReady()

Whether the renderer is able to immediately render media from the current position.

If the renderer is in the STATE_STARTED state then returning true indicates that the renderer has everything that it needs to continue playback. Returning false indicates that the player should pause until the renderer is ready.

If the renderer is in the STATE_ENABLED state then returning true indicates that the renderer is ready for playback to be started. Returning false indicates that it is not.

This method may be called when the renderer is in the following states: STATE_ENABLED, STATE_STARTED.

Returns
`boolean`	Whether the renderer is ready to render media.

render

@CallSuper
public void render(long positionUs, long elapsedRealtimeUs)

Incrementally renders the SampleStream.

If the renderer is in the STATE_ENABLED state then each call to this method will do work toward being ready to render the SampleStream when the renderer is started. If the renderer is in the STATE_STARTED state then calls to this method will render the SampleStream in sync with the specified media positions.

The renderer may also render the very start of the media at the current position (e.g. the first frame of a video stream) while still in the STATE_ENABLED state, unless it's the initial start of the media after calling enable with mayRenderStartOfStream set to false.

This method should return quickly, and should not block if the renderer is unable to make useful progress.

This method may be called when the renderer is in the following states: STATE_ENABLED, STATE_STARTED.

Parameters
`long positionUs`	The current media time in microseconds, measured at the start of the current iteration of the rendering loop.
`long elapsedRealtimeUs`	`elapsedRealtime` in microseconds, measured at the start of the current iteration of the rendering loop.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs.

setPlaybackSpeed

public void setPlaybackSpeed(float currentPlaybackSpeed, float targetPlaybackSpeed)

Indicates the playback speed to this renderer.

The default implementation is a no-op.

Parameters
`float currentPlaybackSpeed`	The factor by which playback is currently sped up.
`float targetPlaybackSpeed`	The target factor by which playback should be sped up. This may be different from `currentPlaybackSpeed`, for example, if the speed is temporarily adjusted for live playback.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs handling the playback speed.

setVideoEffects

public void setVideoEffects(List<Effect> effects)

Sets the video effects to apply.

shouldDropFrame

public boolean shouldDropFrame(
    long earlyUs,
    long elapsedRealtimeUs,
    boolean isLastFrame
)

Returns whether the frame should be dropped.

Parameters
`long earlyUs`	The time until the buffer should be presented in microseconds. A negative value indicates that the buffer is late.
`long elapsedRealtimeUs`	`elapsedRealtime` in microseconds, measured at the start of the current iteration of the rendering loop.
`boolean isLastFrame`	Whether the buffer is the last buffer in the current stream.

shouldForceReleaseFrame

public boolean shouldForceReleaseFrame(long earlyUs, long elapsedSinceLastReleaseUs)

Whether a frame should be forced for release.

Parameters
`long earlyUs`	The time until the buffer should be presented in microseconds. A negative value indicates that the buffer is late.
`long elapsedSinceLastReleaseUs`	The elapsed time since the last frame was released, in microseconds.

Returns
`boolean`	Whether the video frame should be force released.

shouldIgnoreFrame

public boolean shouldIgnoreFrame(
    long earlyUs,
    long positionUs,
    long elapsedRealtimeUs,
    boolean isLastFrame,
    boolean treatDroppedBuffersAsSkipped
)

Returns whether this frame should be ignored.

Parameters
`long earlyUs`	The time until the buffer should be presented in microseconds. A negative value indicates that the buffer is late.
`long positionUs`	The playback position, in microseconds.
`long elapsedRealtimeUs`	`elapsedRealtime` in microseconds, measured at the start of the current iteration of the rendering loop.
`boolean isLastFrame`	Whether the buffer is the last buffer in the current stream.
`boolean treatDroppedBuffersAsSkipped`	Whether dropped buffers should be treated as intentionally skipped.

Returns
`boolean`	Whether this frame should be ignored.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs.

supportsFormat

@RendererCapabilities.Capabilities
public static int supportsFormat(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    Format format
)

Returns the Capabilities of MediaCodecVideoRenderer for a given Format.

Parameters
`Context context`	A context.
`MediaCodecSelector mediaCodecSelector`	The decoder selector.
`Format format`	The `Format` for which to check the `MediaCodecVideoRenderer`'s support.

Returns
`int`	The `Capabilities` for this format.

Throws
`androidx.media3.exoplayer.mediacodec.MediaCodecUtil.DecoderQueryException`	Thrown if there was an error querying decoders.

Protected methods

canReuseCodec

protected 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.

The default implementation does not allow decoder reuse.

Parameters
`MediaCodecInfo codecInfo`	A `MediaCodecInfo` describing the decoder.
`Format oldFormat`	The `Format` for which the existing instance is configured.
`Format newFormat`	The new `Format`.

Returns
`DecoderReuseEvaluation`	The result of the evaluation.

changeVideoSinkInputStream

protected void changeVideoSinkInputStream(
    VideoSink videoSink,
    @VideoSink.InputType int inputType,
    Format format
)

Called when ready to <>change the input stream.

The default implementation applies this renderer's video effects.

codecNeedsSetOutputSurfaceWorkaround

protected boolean codecNeedsSetOutputSurfaceWorkaround(String name)

Returns whether the codec is known to implement setOutputSurface incorrectly.

If true is returned then we fall back to releasing and re-instantiating the codec instead.

Parameters
`String name`	The name of the codec.

Returns
`boolean`	True if the device is known to implement `setOutputSurface` incorrectly.

createDecoderException

protected MediaCodecDecoderException createDecoderException(
    Throwable cause,
    @Nullable MediaCodecInfo codecInfo
)

detachOutputSurfaceV35

@RequiresApi(value = 35)
protected void detachOutputSurfaceV35(MediaCodecAdapter codec)

dropOutputBuffer

protected void dropOutputBuffer(
    MediaCodecAdapter codec,
    int index,
    long presentationTimeUs
)

Drops the output buffer with the specified index.

Parameters
`MediaCodecAdapter codec`	The codec that owns the output buffer.
`int index`	The index of the output buffer to drop.
`long presentationTimeUs`	The presentation time of the output buffer, in microseconds.

getBufferTimestampAdjustmentUs

protected long getBufferTimestampAdjustmentUs()

Returns the timestamp that is added to the buffer presentation time (the player decoding position) to get the frame presentation time, in microseconds.

getCodecBufferFlags

protected int getCodecBufferFlags(DecoderInputBuffer buffer)

Returns the flags that should be set on queueInputBuffer or queueSecureInputBuffer for this buffer.

Parameters
`DecoderInputBuffer buffer`	The input buffer.

Returns
`int`	The flags to set on `queueInputBuffer` or `queueSecureInputBuffer`.

getCodecMaxValues

protected MediaCodecVideoRenderer.CodecMaxValues getCodecMaxValues(
    MediaCodecInfo codecInfo,
    Format format,
    Format[] streamFormats
)

Returns CodecMaxValues suitable for configuring a codec for format in a way that will allow possible adaptation to other compatible formats in streamFormats.

Parameters
`MediaCodecInfo codecInfo`	Information about the `MediaCodec` being configured.
`Format format`	The `Format` for which the codec is being configured.
`Format[] streamFormats`	The possible stream formats.

Returns
`MediaCodecVideoRenderer.CodecMaxValues`	Suitable `CodecMaxValues`.

getCodecNeedsEosPropagation

protected 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.

getCodecOperatingRateV23

protected 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.

The default implementation returns CODEC_OPERATING_RATE_UNSET.

Parameters
`float targetPlaybackSpeed`	The target factor by which playback should be sped up. This may be different from the current playback speed, for example, if the speed is temporarily adjusted for live playback.
`Format format`	The `Format` for which the codec is being configured.
`Format[] streamFormats`	The possible stream formats.

Returns
`float`	The codec operating rate, or `CODEC_OPERATING_RATE_UNSET` if no codec operating rate should be set.

getDecoderInfos

protected 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.

Parameters
`MediaCodecSelector mediaCodecSelector`	The decoder selector.
`Format format`	The `Format` for which a decoder is required.
`boolean requiresSecureDecoder`	Whether a secure decoder is required.

Returns
`List<MediaCodecInfo>`	A list of `MediaCodecInfo`s corresponding to decoders. May be empty.

Throws
`androidx.media3.exoplayer.mediacodec.MediaCodecUtil.DecoderQueryException`	Thrown if there was an error querying decoders.

getMaxInputSize

protected static int getMaxInputSize(MediaCodecInfo codecInfo, Format format)

Returns a maximum input buffer size for a given MediaCodec and Format.

Parameters
`MediaCodecInfo codecInfo`	Information about the `MediaCodec` being configured.
`Format format`	The format.

Returns
`int`	A maximum input buffer size in bytes, or `NO_VALUE` if a maximum could not be determined.

getMediaCodecConfiguration

protected 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.

Parameters
`MediaCodecInfo codecInfo`	Information about the `MediaCodec` being configured.
`Format format`	The `Format` for which the codec is being configured.
`@Nullable MediaCrypto crypto`	For drm protected playbacks, a `MediaCrypto` to use for decryption.
`float codecOperatingRate`	The codec operating rate, or `CODEC_OPERATING_RATE_UNSET` if no codec operating rate should be set.

Returns
`MediaCodecAdapter.Configuration`	The parameters needed to call configure.

getMediaFormat

protected MediaFormat getMediaFormat(
    Format format,
    String codecMimeType,
    MediaCodecVideoRenderer.CodecMaxValues codecMaxValues,
    float codecOperatingRate,
    boolean deviceNeedsNoPostProcessWorkaround,
    int tunnelingAudioSessionId
)

Returns the framework MediaFormat that should be used to configure the decoder.

Parameters
`Format format`	The `Format` of media.
`String codecMimeType`	The MIME type handled by the codec.
`MediaCodecVideoRenderer.CodecMaxValues codecMaxValues`	Codec max values that should be used when configuring the decoder.
`float codecOperatingRate`	The codec operating rate, or `CODEC_OPERATING_RATE_UNSET` if no codec operating rate should be set.
`boolean deviceNeedsNoPostProcessWorkaround`	Whether the device is known to do post processing by default that isn't compatible with ExoPlayer.
`int tunnelingAudioSessionId`	The audio session id to use for tunneling, or `AUDIO_SESSION_ID_UNSET` if tunneling should not be enabled.

Returns
`MediaFormat`	The framework `MediaFormat` that should be used to configure the decoder.

getSurface

protected @Nullable Surface getSurface()

Returns the output surface.

handleInputBufferSupplementalData

@TargetApi(value = 29)
protected void handleInputBufferSupplementalData(DecoderInputBuffer buffer)

Handles supplemental data associated with an input buffer.

The default implementation is a no-op.

Parameters
`DecoderInputBuffer buffer`	The input buffer that is about to be queued.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	Thrown if an error occurs handling supplemental data.

maybeDropBuffersToKeyframe

protected boolean maybeDropBuffersToKeyframe(
    long positionUs,
    boolean treatDroppedBuffersAsSkipped
)

Drops frames from the current output buffer to the next keyframe at or before the playback position. If no such keyframe exists, as the playback position is inside the same group of pictures as the buffer being processed, returns false. Returns true otherwise.

Parameters
`long positionUs`	The current playback position, in microseconds.
`boolean treatDroppedBuffersAsSkipped`	Whether dropped buffers should be treated as intentionally skipped.

Returns
`boolean`	Whether any buffers were dropped.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs flushing the codec.

maybeInitializeProcessingPipeline

@CallSuper
protected boolean maybeInitializeProcessingPipeline(Format format)

Initializes the processing pipeline, if needed by the implementation.

The default implementation is a no-op.

Parameters
`Format format`	The `Format` for which the codec is being configured.

Returns
`boolean`	Returns `true` when the processing pipeline is successfully initialized, or the `renderer` does not use a processing pipeline. The caller should try again later, if `false` is returned.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs preparing for initializing the codec.

onCodecError

protected void onCodecError(Exception codecError)

Called when a codec error has occurred.

The default implementation is a no-op.

Parameters
`Exception codecError`	The error.

onCodecInitialized

protected void onCodecInitialized(
    String name,
    MediaCodecAdapter.Configuration configuration,
    long initializedTimestampMs,
    long initializationDurationMs
)

Called when a MediaCodec has been created and configured.

The default implementation is a no-op.

Parameters
`String name`	The name of the codec that was initialized.
`MediaCodecAdapter.Configuration configuration`	The `MediaCodecAdapter.Configuration` used to configure the codec.
`long initializedTimestampMs`	`elapsedRealtime` when initialization finished.
`long initializationDurationMs`	The time taken to initialize the codec in milliseconds.

onCodecReleased

protected void onCodecReleased(String name)

Called when a MediaCodec has been released.

The default implementation is a no-op.

Parameters
`String name`	The name of the codec that was released.

onDisabled

protected void onDisabled()

Called when the renderer is disabled.

The default implementation is a no-op.

onEnabled

protected void onEnabled(boolean joining, boolean mayRenderStartOfStream)

Called when the renderer is enabled.

The default implementation is a no-op.

Parameters
`boolean joining`	Whether this renderer is being enabled to join an ongoing playback.
`boolean mayRenderStartOfStream`	Whether this renderer is allowed to render the start of the stream even if the state is not `STATE_STARTED` yet.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs.

onInit

protected void onInit()

Called when the renderer is initialized.

onInputFormatChanged

protected @Nullable DecoderReuseEvaluation onInputFormatChanged(FormatHolder formatHolder)

Called when a new Format is read from the upstream MediaPeriod.

Parameters
`FormatHolder formatHolder`	A `FormatHolder` that holds the new `Format`.

Returns
`@Nullable DecoderReuseEvaluation`	The result of the evaluation to determine whether the existing decoder instance can be reused for the new format, or `null` if the renderer did not have a decoder.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs re-initializing the `MediaCodec`.

onOutputFormatChanged

protected void onOutputFormatChanged(Format format, @Nullable MediaFormat mediaFormat)

Called when one of the output formats changes.

The default implementation is a no-op.

Parameters
`Format format`	The input `Format` to which future output now corresponds. If the renderer is in bypass mode, this is also the output format.
`@Nullable MediaFormat mediaFormat`	The codec output `MediaFormat`, or `null` if the renderer is in bypass mode.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	Thrown if an error occurs configuring the output.

onPositionReset

protected void onPositionReset(long positionUs, boolean joining)

Called when the position is reset. This occurs when the renderer is enabled after onStreamChanged has been called, and also when a position discontinuity is encountered.

After a position reset, the renderer's SampleStream is guaranteed to provide samples starting from a key frame.

The default implementation is a no-op.

Parameters
`long positionUs`	The new playback position in microseconds.
`boolean joining`	Whether this renderer is being enabled to join an ongoing playback.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs.

onProcessedOutputBuffer

@CallSuper
protected void onProcessedOutputBuffer(long presentationTimeUs)

Called when an output buffer is successfully processed.

Parameters
`long presentationTimeUs`	The timestamp associated with the output buffer.

onProcessedStreamChange

protected void onProcessedStreamChange()

Called after the last output buffer before a stream change has been processed.

onProcessedTunneledBuffer

protected void onProcessedTunneledBuffer(long presentationTimeUs)

Called when a buffer was processed in tunneling mode.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`

onQueueInputBuffer

@CallSuper
protected void onQueueInputBuffer(DecoderInputBuffer buffer)

Called immediately before an input buffer is queued into the codec.

In tunneling mode for pre Marshmallow, the buffer is treated as if immediately output.

Parameters
`DecoderInputBuffer buffer`	The buffer to be queued.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	Thrown if an error occurs handling the input buffer.

onRelease

protected void onRelease()

Called when the renderer is released.

The default implementation is a no-op.

onReset

protected void onReset()

Called when the renderer is reset.

The default implementation is a no-op.

onStarted

protected void onStarted()

Called when the renderer is started.

The default implementation is a no-op.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs.

onStopped

protected void onStopped()

Called when the renderer is stopped.

The default implementation is a no-op.

onStreamChanged

protected void onStreamChanged(
    Format[] formats,
    long startPositionUs,
    long offsetUs,
    MediaSource.MediaPeriodId mediaPeriodId
)

Called when the renderer's stream has changed. This occurs when the renderer is enabled after onEnabled has been called, and also when the stream has been replaced whilst the renderer is enabled or started.

The default implementation is a no-op.

Parameters
`Format[] formats`	The enabled formats.
`long startPositionUs`	The start position of the new stream in renderer time (microseconds).
`long offsetUs`	The offset that will be added to the timestamps of buffers read via `readSource` so that decoder input buffers have monotonically increasing timestamps.
`MediaSource.MediaPeriodId mediaPeriodId`	The `MediaSource.MediaPeriodId` of the `MediaPeriod` that produces the stream.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs.

onWakeupListenerSet

protected void onWakeupListenerSet(Renderer.WakeupListener wakeupListener)

Called when a WakeupListener is set.

The default implementation is a no-op.

Parameters
`Renderer.WakeupListener wakeupListener`	The `WakeupListener`.

processOutputBuffer

protected 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.

When a new ByteBuffer is passed to this method its position and limit delineate the data to be processed. The return value indicates whether the buffer was processed in full. If true is returned then the next call to this method will receive a new buffer to be processed. If false is returned then the same buffer will be passed to the next call. An implementation of this method is free to modify the buffer and can assume that the buffer will not be externally modified between successive calls. Hence an implementation can, for example, modify the buffer's position to keep track of how much of the data it has processed.

Note that the first call to this method following a call to onPositionReset will always receive a new ByteBuffer to be processed.

Parameters
`long positionUs`	The current media time in microseconds, measured at the start of the current iteration of the rendering loop.
`long elapsedRealtimeUs`	`elapsedRealtime` in microseconds, measured at the start of the current iteration of the rendering loop.
`@Nullable MediaCodecAdapter codec`	The `MediaCodecAdapter` instance, or null in bypass mode were no codec is used.
`@Nullable ByteBuffer buffer`	The output buffer to process, or null if the buffer data is not made available to the application layer (see `getOutputBuffer`). This `buffer` can only be null for video data. Note that the buffer data can still be rendered in this case by using the `bufferIndex`.
`int bufferIndex`	The index of the output buffer.
`int bufferFlags`	The flags attached to the output buffer.
`int sampleCount`	The number of samples extracted from the sample queue in the buffer. This allows handling multiple samples as a batch for efficiency.
`long bufferPresentationTimeUs`	The presentation time of the output buffer in microseconds.
`boolean isDecodeOnlyBuffer`	Whether the buffer timestamp is less than the intended playback start position.
`boolean isLastBuffer`	Whether the buffer is known to contain the last sample of the current stream. This flag is set on a best effort basis, and any logic relying on it should degrade gracefully to handle cases where it's not set.
`Format format`	The `Format` associated with the buffer.

Returns
`boolean`	Whether the output buffer was fully processed (for example, rendered or skipped).

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs processing the output buffer.

renderOutputBuffer

protected void renderOutputBuffer(
    MediaCodecAdapter codec,
    int index,
    long presentationTimeUs
)

renderOutputBufferV21

protected void renderOutputBufferV21(
    MediaCodecAdapter codec,
    int index,
    long presentationTimeUs,
    long releaseTimeNs
)

Renders the output buffer with the specified index.

Parameters
`MediaCodecAdapter codec`	The codec that owns the output buffer.
`int index`	The index of the output buffer to drop.
`long presentationTimeUs`	The presentation time of the output buffer, in microseconds.
`long releaseTimeNs`	The wallclock time at which the frame should be displayed, in nanoseconds.

renderToEndOfStream

protected void renderToEndOfStream()

Incrementally renders any remaining output.

The default implementation is a no-op.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	Thrown if an error occurs rendering remaining output.

resetCodecStateForFlush

@CallSuper
protected void resetCodecStateForFlush()

Resets the renderer internal state after a codec flush.

setOutputSurfaceV23

@RequiresApi(value = 23)
protected void setOutputSurfaceV23(MediaCodecAdapter codec, Surface surface)

shouldDiscardDecoderInputBuffer

protected boolean shouldDiscardDecoderInputBuffer(DecoderInputBuffer buffer)

Returns whether the input buffer should be discarded before decoding.

Implement this method to to skip decoding of buffers that are not needed during a seek, or to drop input buffers that cannot be rendered on time. See BUFFER_FLAG_NOT_DEPENDED_ON.

Subclasses that implement this method are responsible for updating decoderCounters. For codecs with out-of-order buffers, consecutive dropped input buffers may have to be counted after frame reordering. For example, in processOutputBuffer.

Implementations of this method must update the decoder input buffer contents. Data that is only used for output at the current timeUs should be removed. Data that is referenced by later input buffers should remain in the current buffer.

Parameters
`DecoderInputBuffer buffer`	The input buffer.

shouldDropBuffersToKeyframe

protected boolean shouldDropBuffersToKeyframe(
    long earlyUs,
    long elapsedRealtimeUs,
    boolean isLastBuffer
)

Returns whether to drop all buffers from the buffer being processed to the keyframe at or after the current playback position, if possible.

Parameters
`long earlyUs`	The time until the current buffer should be presented in microseconds. A negative value indicates that the buffer is late.
`long elapsedRealtimeUs`	`elapsedRealtime` in microseconds, measured at the start of the current iteration of the rendering loop.
`boolean isLastBuffer`	Whether the buffer is the last buffer in the current stream.

shouldDropOutputBuffer

protected boolean shouldDropOutputBuffer(
    long earlyUs,
    long elapsedRealtimeUs,
    boolean isLastBuffer
)

Returns whether the buffer being processed should be dropped.

Parameters
`long earlyUs`	The time until the buffer should be presented in microseconds. A negative value indicates that the buffer is late.
`long elapsedRealtimeUs`	`elapsedRealtime` in microseconds, measured at the start of the current iteration of the rendering loop.
`boolean isLastBuffer`	Whether the buffer is the last buffer in the current stream.

shouldForceRenderOutputBuffer

protected boolean shouldForceRenderOutputBuffer(
    long earlyUs,
    long elapsedSinceLastRenderUs
)

Returns whether to force rendering an output buffer.

Parameters
`long earlyUs`	The time until the current buffer should be presented in microseconds. A negative value indicates that the buffer is late.
`long elapsedSinceLastRenderUs`	The elapsed time since the last output buffer was rendered, in microseconds.

Returns
`boolean`	Returns whether to force rendering an output buffer.

shouldInitCodec

protected boolean shouldInitCodec(MediaCodecInfo codecInfo)

shouldSkipBuffersWithIdenticalReleaseTime

protected boolean shouldSkipBuffersWithIdenticalReleaseTime()

Returns whether to skip buffers that have an identical release time as the previous released buffer.

shouldUseDetachedSurface

protected boolean shouldUseDetachedSurface(MediaCodecInfo codecInfo)

shouldUsePlaceholderSurface

protected boolean shouldUsePlaceholderSurface(MediaCodecInfo codecInfo)

skipOutputBuffer

protected void skipOutputBuffer(
    MediaCodecAdapter codec,
    int index,
    long presentationTimeUs
)

Skips the output buffer with the specified index.

Parameters
`MediaCodecAdapter codec`	The codec that owns the output buffer.
`int index`	The index of the output buffer to skip.
`long presentationTimeUs`	The presentation time of the output buffer, in microseconds.

supportsFormat

@RendererCapabilities.Capabilities
protected int supportsFormat(MediaCodecSelector mediaCodecSelector, Format format)

Returns the Capabilities for the given Format.

Parameters
`MediaCodecSelector mediaCodecSelector`	The decoder selector.
`Format format`	The `Format`.

Returns
`int`	The `Capabilities` for this `Format`.

Throws
`androidx.media3.exoplayer.mediacodec.MediaCodecUtil.DecoderQueryException`	If there was an error querying decoders.

updateDroppedBufferCounters

protected void updateDroppedBufferCounters(
    int droppedInputBufferCount,
    int droppedDecoderBufferCount
)

Updates local counters and decoderCounters to reflect that buffers were dropped.

Parameters
`int droppedInputBufferCount`	The number of buffers dropped from the source before being passed to the decoder.
`int droppedDecoderBufferCount`	The number of buffers dropped after being passed to the decoder.

updateVideoFrameProcessingOffsetCounters

protected void updateVideoFrameProcessingOffsetCounters(long processingOffsetUs)

Updates local counters and DecoderCounters with a new video frame processing offset.

Parameters
`long processingOffsetUs`	The video frame processing offset.

MediaCodecVideoRenderer

Summary

Nested types

Public constructors

Protected constructors

Public methods

Protected methods

Inherited Constants

Inherited fields

Inherited methods

Public constructors

MediaCodecVideoRenderer

MediaCodecVideoRenderer

MediaCodecVideoRenderer

MediaCodecVideoRenderer

MediaCodecVideoRenderer

MediaCodecVideoRenderer

MediaCodecVideoRenderer

MediaCodecVideoRenderer

Protected constructors

MediaCodecVideoRenderer

Public methods

enableMayRenderStartOfStream

getCodecMaxInputSize

getName

handleMessage

isEnded

isReady

render

setPlaybackSpeed

setVideoEffects

shouldDropFrame

shouldForceReleaseFrame

shouldIgnoreFrame

supportsFormat

Protected methods

canReuseCodec

changeVideoSinkInputStream

codecNeedsSetOutputSurfaceWorkaround

createDecoderException

detachOutputSurfaceV35

dropOutputBuffer

getBufferTimestampAdjustmentUs

getCodecBufferFlags

getCodecMaxValues

getCodecNeedsEosPropagation

getCodecOperatingRateV23

getDecoderInfos

getMaxInputSize

getMediaCodecConfiguration

getMediaFormat

getSurface

handleInputBufferSupplementalData

maybeDropBuffersToKeyframe

maybeInitializeProcessingPipeline

onCodecError

onCodecInitialized

onCodecReleased

onDisabled

onEnabled

onInit

onInputFormatChanged

onOutputFormatChanged

onPositionReset

onProcessedOutputBuffer

onProcessedStreamChange

onProcessedTunneledBuffer

onQueueInputBuffer

onRelease

onReset

onStarted

onStopped

onStreamChanged

onWakeupListenerSet

processOutputBuffer

renderOutputBuffer

renderOutputBufferV21

renderToEndOfStream

resetCodecStateForFlush

setOutputSurfaceV23