DecoderVideoRenderer

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
abstract class DecoderVideoRenderer : BaseRenderer

kotlin.Any
↳	androidx.media3.exoplayer.BaseRenderer
	↳	androidx.media3.exoplayer.video.DecoderVideoRenderer

Decodes and renders video using a Decoder.

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

Message with type MSG_SET_VIDEO_OUTPUT to set the output surface. The message payload should be the target Surface or VideoDecoderOutputBufferRenderer, or null. Other non-null payloads have the effect of clearing the output.
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

Protected constructors
`DecoderVideoRenderer( allowedJoiningTimeMs: Long, eventHandler: Handler?, eventListener: VideoRendererEventListener?, maxDroppedFramesToNotify: Int )`

Public functions
`Unit`	`enableMayRenderStartOfStream()` Enables this renderer to render the start of the stream even if the state is not `STATE_STARTED` yet.
`Unit`	`handleMessage(@Renderer.MessageType messageType: Int, message: Any?)` 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.
`Unit`	`render(positionUs: Long, elapsedRealtimeUs: Long)` Incrementally renders the `SampleStream`.

Protected functions
`DecoderReuseEvaluation!`	`canReuseDecoder(decoderName: String!, oldFormat: Format!, newFormat: Format!)` Evaluates whether the existing decoder can be reused for a new `Format`.
`abstract Decoder<DecoderInputBuffer!, VideoDecoderOutputBuffer!, DecoderException!>!`	`createDecoder(format: Format!, cryptoConfig: CryptoConfig?)` Creates a decoder for the given format.
`Unit`	`dropOutputBuffer(outputBuffer: VideoDecoderOutputBuffer!)` Drops the specified output buffer and releases it.
`Unit`	`@CallSuper flushDecoder()` Flushes the decoder.
`Boolean`	`maybeDropBuffersToKeyframe(positionUs: Long)` Drops frames from the current output buffer to the next keyframe at or before the playback position.
`Unit`	`onDisabled()` Called when the renderer is disabled.
`Unit`	`onEnabled(joining: Boolean, mayRenderStartOfStream: Boolean)` Called when the renderer is enabled.
`Unit`	`@CallSuper onInputFormatChanged(formatHolder: FormatHolder!)` Called when a new format is read from the upstream source.
`Unit`	`onPositionReset(positionUs: Long, joining: Boolean)` Called when the position is reset.
`Unit`	`@CallSuper onProcessedOutputBuffer(presentationTimeUs: Long)` Called when an output buffer is successfully processed.
`Unit`	`onQueueInputBuffer(buffer: DecoderInputBuffer!)` Called immediately before an input buffer is queued into the decoder.
`Unit`	`onStarted()` Called when the renderer is started.
`Unit`	`onStopped()` Called when the renderer is stopped.
`Unit`	`onStreamChanged( formats: Array<Format!>!, startPositionUs: Long, offsetUs: Long, mediaPeriodId: MediaSource.MediaPeriodId! )` Called when the renderer's stream has changed.
`Unit`	`@CallSuper releaseDecoder()` Releases the decoder.
`Unit`	`renderOutputBuffer( outputBuffer: VideoDecoderOutputBuffer!, presentationTimeUs: Long, outputFormat: Format! )` Renders the specified output buffer.
`abstract Unit`	`renderOutputBufferToSurface( outputBuffer: VideoDecoderOutputBuffer!, surface: Surface! )` Renders the specified output buffer to the passed surface.
`abstract Unit`	`setDecoderOutputMode(@C.VideoOutputMode outputMode: Int)` Sets output mode of the decoder.
`Unit`	`setOutput(output: Any?)` Sets the video output.
`Boolean`	`shouldDropBuffersToKeyframe(earlyUs: Long, elapsedRealtimeUs: Long)` 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(earlyUs: Long, elapsedRealtimeUs: Long)` Returns whether the buffer being processed should be dropped.
`Boolean`	`shouldForceRenderOutputBuffer( earlyUs: Long, elapsedSinceLastRenderUs: Long )` Returns whether to force rendering an output buffer.
`Unit`	`skipOutputBuffer(outputBuffer: VideoDecoderOutputBuffer!)` Skips the specified output buffer and releases it.
`Unit`	`updateDroppedBufferCounters( droppedInputBufferCount: Int, droppedDecoderBufferCount: Int )` Updates local counters and `decoderCounters` to reflect that buffers were dropped.

Protected properties
`DecoderCounters!`	`decoderCounters` Decoder event counters used for debugging purposes.

Inherited Constants

From androidx.media3.exoplayer.Renderer

`const Long`	`DEFAULT_DURATION_TO_PROGRESS_US = 10000` Default minimum duration that the playback clock must advance before `render` can make progress.
`const Int`	`MSG_CUSTOM_BASE = 10000` Applications or extensions may define custom `MSG_*` constants that can be passed to renderers.
`const Int`	`MSG_SET_AUDIO_ATTRIBUTES = 3` A type of a message that can be passed to an audio renderer via `createMessage`.
`const Int`	`MSG_SET_AUDIO_SESSION_ID = 10` The type of a message that can be passed to audio and video renderers via `createMessage`.
`const Int`	`MSG_SET_AUX_EFFECT_INFO = 6` A type of a message that can be passed to an audio renderer via `createMessage`.
`const Int`	`MSG_SET_CAMERA_MOTION_LISTENER = 8` The type of a message that can be passed to a camera motion renderer via `createMessage`.
`const Int`	`MSG_SET_CHANGE_FRAME_RATE_STRATEGY = 5` The type of a message that can be passed to a video renderer via `createMessage`.
`const Int`	`MSG_SET_IMAGE_OUTPUT = 15` The type of message that can be passed to an image renderer to set a desired image output.
`const Int`	`MSG_SET_PREFERRED_AUDIO_DEVICE = 12` The type of a message that can be passed to audio renderers via `createMessage`.
`const Int`	`MSG_SET_PRIORITY = 16` The type of message that can be passed to a renderer to set its priority.
`const Int`	`MSG_SET_SCALING_MODE = 4` The type of a message that can be passed to a `MediaCodec`-based video renderer via `createMessage`.
`const Int`	`MSG_SET_SKIP_SILENCE_ENABLED = 9` The type of a message that can be passed to an audio renderer via `createMessage`.
`const Int`	`MSG_SET_VIDEO_EFFECTS = 13` The type of a message that can be passed to a video renderer.
`const Int`	`MSG_SET_VIDEO_FRAME_METADATA_LISTENER = 7` The type of a message that can be passed to a video renderer via `createMessage`.
`const Int`	`MSG_SET_VIDEO_OUTPUT = 1` The type of a message that can be passed to a video renderer via `createMessage`.
`const 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.
`const Int`	`MSG_SET_VOLUME = 2` A type of a message that can be passed to an audio renderer via `createMessage`.
`const 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.
`const Int`	`STATE_DISABLED = 0` The renderer is disabled.
`const Int`	`STATE_ENABLED = 1` The renderer is enabled but not started.
`const Int`	`STATE_STARTED = 2` The renderer is started.

From androidx.media3.exoplayer.RendererCapabilities

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

Inherited functions

From androidx.media3.exoplayer.BaseRenderer

`Unit`	`clearListener()` Clears the `Listener`.
`ExoPlaybackException!`	`createRendererException( cause: Throwable!, format: Format?, @PlaybackException.ErrorCode errorCode: Int )` Creates an `ExoPlaybackException` of type `TYPE_RENDERER` for this renderer.
`ExoPlaybackException!`	`createRendererException( cause: Throwable!, format: Format?, isRecoverable: Boolean, @PlaybackException.ErrorCode errorCode: Int )` Creates an `ExoPlaybackException` of type `TYPE_RENDERER` for this renderer.
`Unit`	`disable()` Disable the renderer, transitioning it to the `STATE_DISABLED` state.
`Unit`	`enable( configuration: RendererConfiguration!, formats: Array<Format!>!, stream: SampleStream!, positionUs: Long, joining: Boolean, mayRenderStartOfStream: Boolean, startPositionUs: Long, offsetUs: Long, mediaPeriodId: MediaSource.MediaPeriodId! )` Enables the renderer to consume from the specified `SampleStream`.
`RendererCapabilities!`	`getCapabilities()` Returns the capabilities of the renderer.
`MediaClock?`	`getMediaClock()` If the renderer advances its own playback position then this method returns a corresponding `MediaClock`.
`Boolean`	`hasReadStreamToEnd()` Returns whether the renderer has read the current `SampleStream` to the end.
`Unit`	`init(index: Int, playerId: PlayerId!, clock: Clock!)` Initializes the renderer for playback with a player.
`Boolean`	`isCurrentStreamFinal()` Returns whether the current `SampleStream` will be the final one supplied before the renderer is next disabled or reset.
`Boolean`	`isSourceReady()` Returns whether the upstream source is ready.
`Unit`	`maybeThrowStreamError()` Throws an error that's preventing the renderer from reading from its `SampleStream`.
`Unit`	`onInit()` Called when the renderer is initialized.
`Unit`	`onRelease()` Called when the renderer is released.
`Unit`	`onRendererCapabilitiesChanged()` Called when the renderer capabilities are changed.
`Unit`	`onReset()` Called when the renderer is reset.
`Unit`	`onTimelineChanged(timeline: Timeline!)` Called when a new timeline is `set`.
`Int`	`@SampleStream.ReadDataResult readSource( formatHolder: FormatHolder!, buffer: DecoderInputBuffer!, @SampleStream.ReadFlags readFlags: Int )` Reads from the enabled upstream source.
`Unit`	`release()` Releases the renderer.
`Unit`	`replaceStream( formats: Array<Format!>!, stream: SampleStream!, startPositionUs: Long, offsetUs: Long, mediaPeriodId: MediaSource.MediaPeriodId! )` Replaces the `SampleStream` from which samples will be consumed.
`Unit`	`reset()` Forces the renderer to give up any resources (e.g. media decoders) that it may be holding.
`Unit`	`resetPosition(positionUs: Long)` Signals to the renderer that a position discontinuity has occurred.
`Unit`	`setCurrentStreamFinal()` Signals to the renderer that the current `SampleStream` will be the final one supplied before it is next disabled or reset.
`Unit`	`setListener(listener: RendererCapabilities.Listener!)` Sets the `Listener`.
`Int`	`skipSource(positionUs: Long)` Attempts to skip to the keyframe before the specified position, or to the end of the stream if `positionUs` is beyond it.
`Unit`	`start()` Starts the renderer, meaning that calls to `render` will cause media to be rendered.
`Unit`	`stop()` Stops the renderer, transitioning it to the `STATE_ENABLED` state.
`Int`	`@RendererCapabilities.AdaptiveSupport supportsMixedMimeTypeAdaptation()` Returns the extent to which the `Renderer` supports adapting between supported formats that have different MIME types.

From androidx.media3.exoplayer.Renderer

`abstract Unit`	`enable( configuration: RendererConfiguration!, formats: Array<Format!>!, stream: SampleStream!, positionUs: Long, joining: Boolean, mayRenderStartOfStream: Boolean, startPositionUs: Long, offsetUs: Long, mediaPeriodId: MediaSource.MediaPeriodId! )` Enables the renderer to consume from the specified `SampleStream`.
`Long`	`getDurationToProgressUs(positionUs: Long, elapsedRealtimeUs: Long)` Returns minimum amount of playback clock time that must pass in order for the `render` call to make progress.
`abstract String!`	`getName()` Returns the name of this renderer, for logging and debugging purposes.
`abstract Unit`	`replaceStream( formats: Array<Format!>!, stream: SampleStream!, startPositionUs: Long, offsetUs: Long, mediaPeriodId: MediaSource.MediaPeriodId! )` Replaces the `SampleStream` from which samples will be consumed.
`Unit`	`setPlaybackSpeed(currentPlaybackSpeed: Float, targetPlaybackSpeed: Float)` Indicates the playback speed to this renderer.

From androidx.media3.exoplayer.RendererCapabilities

`java-static Int`	`@RendererCapabilities.Capabilities create(@C.FormatSupport formatSupport: Int)` Returns `Capabilities` for the given `C.FormatSupport`.
`java-static Int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport formatSupport: Int, @RendererCapabilities.AdaptiveSupport adaptiveSupport: Int, @RendererCapabilities.TunnelingSupport tunnelingSupport: Int )` Returns `Capabilities` combining the given `C.FormatSupport`, and `TunnelingSupport`.
`java-static Int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport formatSupport: Int, @RendererCapabilities.AdaptiveSupport adaptiveSupport: Int, @RendererCapabilities.TunnelingSupport tunnelingSupport: Int, @RendererCapabilities.AudioOffloadSupport audioOffloadSupport: Int )` Returns `Capabilities` combining the given `C.FormatSupport`, , `TunnelingSupport`, and `AudioOffloadSupport`.
`java-static Int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport formatSupport: Int, @RendererCapabilities.AdaptiveSupport adaptiveSupport: Int, @RendererCapabilities.TunnelingSupport tunnelingSupport: Int, @RendererCapabilities.HardwareAccelerationSupport hardwareAccelerationSupport: Int, @RendererCapabilities.DecoderSupport decoderSupport: Int )` Returns `Capabilities` combining the given `C.FormatSupport`, , `TunnelingSupport`, `HardwareAccelerationSupport`, and .
`java-static Int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport formatSupport: Int, @RendererCapabilities.AdaptiveSupport adaptiveSupport: Int, @RendererCapabilities.TunnelingSupport tunnelingSupport: Int, @RendererCapabilities.HardwareAccelerationSupport hardwareAccelerationSupport: Int, @RendererCapabilities.DecoderSupport decoderSupport: Int, @RendererCapabilities.AudioOffloadSupport audioOffloadSupport: Int )` Returns `Capabilities` combining the given `C.FormatSupport`, , `TunnelingSupport`, `HardwareAccelerationSupport`, and `AudioOffloadSupport`.
`java-static Int`	`@RendererCapabilities.AdaptiveSupport getAdaptiveSupport(@RendererCapabilities.Capabilities supportFlags: Int)` Returns the `AdaptiveSupport` from the combined `Capabilities`.
`java-static Int`	`@RendererCapabilities.AudioOffloadSupport getAudioOffloadSupport( @RendererCapabilities.Capabilities supportFlags: Int )` Returns the `AudioOffloadSupport` from the combined `Capabilities`.
`java-static Int`	`@RendererCapabilities.DecoderSupport getDecoderSupport(@RendererCapabilities.Capabilities supportFlags: Int)` Returns the `DecoderSupport` from the combined `Capabilities`.
`java-static Int`	`@C.FormatSupport getFormatSupport(@RendererCapabilities.Capabilities supportFlags: Int)` Returns the `C.FormatSupport` from the combined `Capabilities`.
`java-static Int`	`@RendererCapabilities.HardwareAccelerationSupport getHardwareAccelerationSupport( @RendererCapabilities.Capabilities supportFlags: Int )` Returns the `HardwareAccelerationSupport` from the combined `Capabilities`.
`java-static Int`	`@RendererCapabilities.TunnelingSupport getTunnelingSupport(@RendererCapabilities.Capabilities supportFlags: Int)` Returns the `TunnelingSupport` from the combined `Capabilities`.
`java-static Boolean`	`isFormatSupported( @RendererCapabilities.Capabilities supportFlags: Int, allowExceedsCapabilities: Boolean )` Returns whether the `C.FormatSupport` from the combined `Capabilities` indicates the format is supported.
`Unit`	`setListener(listener: RendererCapabilities.Listener!)` Sets the `Listener`.
`abstract Int`	`@RendererCapabilities.Capabilities supportsFormat(format: Format!)` Returns the extent to which the `Renderer` supports a given format.

Inherited properties

From androidx.media3.exoplayer.BaseRenderer

`@MonotonicNonNull Clock!`	`@MonotonicNonNull clock`
`RendererConfiguration?`	`configuration`
`FormatHolder!`	`formatHolder`
`Int`	`index`
`Long`	`lastResetPositionUs`
`@MonotonicNonNull PlayerId!`	`@MonotonicNonNull playerId`
`Long`	`readingPositionUs`
`Int`	`state`
`SampleStream?`	`stream`
`Array<Format!>?`	`streamFormats`
`Long`	`streamOffsetUs`
`Timeline!`	`timeline`
`Int`	`@C.TrackType trackType`

Protected constructors

DecoderVideoRenderer

protected DecoderVideoRenderer(
    allowedJoiningTimeMs: Long,
    eventHandler: Handler?,
    eventListener: VideoRendererEventListener?,
    maxDroppedFramesToNotify: Int
)

Parameters
`allowedJoiningTimeMs: Long`	The maximum duration in milliseconds for which this video renderer can attempt to seamlessly join an ongoing playback.
`eventHandler: Handler?`	A handler to use when delivering events to `eventListener`. May be null if delivery of events is not required.
`eventListener: VideoRendererEventListener?`	A listener of events. May be null if delivery of events is not required.
`maxDroppedFramesToNotify: Int`	The maximum number of frames that can be dropped between invocations of `onDroppedFrames`.

Public functions

enableMayRenderStartOfStream

fun enableMayRenderStartOfStream(): Unit

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.

handleMessage

fun handleMessage(@Renderer.MessageType messageType: Int, message: Any?): Unit

Handles a message delivered to the target.

Parameters
`@Renderer.MessageType messageType: Int`	The message type.
`message: Any?`	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

fun isEnded(): Boolean

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

fun isReady(): Boolean

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

fun render(positionUs: Long, elapsedRealtimeUs: Long): Unit

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
`positionUs: Long`	The current media time in microseconds, measured at the start of the current iteration of the rendering loop.
`elapsedRealtimeUs: Long`	`elapsedRealtime` in microseconds, measured at the start of the current iteration of the rendering loop.

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

Protected functions

canReuseDecoder

protected fun canReuseDecoder(decoderName: String!, oldFormat: Format!, newFormat: Format!): DecoderReuseEvaluation!

Evaluates whether the existing decoder can be reused for a new Format.

The default implementation does not allow decoder reuse.

Parameters
`decoderName: String!`	The name of the decoder.
`oldFormat: Format!`	The previous format.
`newFormat: Format!`	The new format.

Returns
`DecoderReuseEvaluation!`	The result of the evaluation.

createDecoder

protected abstract fun createDecoder(format: Format!, cryptoConfig: CryptoConfig?): Decoder<DecoderInputBuffer!, VideoDecoderOutputBuffer!, DecoderException!>!

Creates a decoder for the given format.

Parameters
`format: Format!`	The format for which a decoder is required.
`cryptoConfig: CryptoConfig?`	The `CryptoConfig` object required for decoding encrypted content. May be null and can be ignored if decoder does not handle encrypted content.

Returns
`Decoder<DecoderInputBuffer!, VideoDecoderOutputBuffer!, DecoderException!>!`	The decoder.

Throws
`androidx.media3.decoder.DecoderException`	If an error occurred creating a suitable decoder.

dropOutputBuffer

protected fun dropOutputBuffer(outputBuffer: VideoDecoderOutputBuffer!): Unit

Drops the specified output buffer and releases it.

Parameters
`outputBuffer: VideoDecoderOutputBuffer!`	The output buffer to drop.

flushDecoder

@CallSuper
protected fun flushDecoder(): Unit

Flushes the decoder.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs reinitializing a decoder.

maybeDropBuffersToKeyframe

protected fun maybeDropBuffersToKeyframe(positionUs: Long): Boolean

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
`positionUs: Long`	The current playback position, in microseconds.

Returns
`Boolean`	Whether any buffers were dropped.

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

onDisabled

protected fun onDisabled(): Unit

Called when the renderer is disabled.

The default implementation is a no-op.

onEnabled

protected fun onEnabled(joining: Boolean, mayRenderStartOfStream: Boolean): Unit

Called when the renderer is enabled.

The default implementation is a no-op.

Parameters
`joining: Boolean`	Whether this renderer is being enabled to join an ongoing playback.
`mayRenderStartOfStream: Boolean`	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.

onInputFormatChanged

@CallSuper
protected fun onInputFormatChanged(formatHolder: FormatHolder!): Unit

Called when a new format is read from the upstream source.

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

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs (re-)initializing the decoder.

onPositionReset

protected fun onPositionReset(positionUs: Long, joining: Boolean): Unit

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
`positionUs: Long`	The new playback position in microseconds.
`joining: Boolean`	Whether this renderer is being enabled to join an ongoing playback.

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

onProcessedOutputBuffer

@CallSuper
protected fun onProcessedOutputBuffer(presentationTimeUs: Long): Unit

Called when an output buffer is successfully processed.

Parameters
`presentationTimeUs: Long`	The timestamp associated with the output buffer.

onQueueInputBuffer

protected fun onQueueInputBuffer(buffer: DecoderInputBuffer!): Unit

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

The default implementation is a no-op.

Parameters
`buffer: DecoderInputBuffer!`	The buffer that will be queued.

onStarted

protected fun onStarted(): Unit

Called when the renderer is started.

The default implementation is a no-op.

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

onStopped

protected fun onStopped(): Unit

Called when the renderer is stopped.

The default implementation is a no-op.

onStreamChanged

protected fun onStreamChanged(
    formats: Array<Format!>!,
    startPositionUs: Long,
    offsetUs: Long,
    mediaPeriodId: MediaSource.MediaPeriodId!
): Unit

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
`formats: Array<Format!>!`	The enabled formats.
`startPositionUs: Long`	The start position of the new stream in renderer time (microseconds).
`offsetUs: Long`	The offset that will be added to the timestamps of buffers read via `readSource` so that decoder input buffers have monotonically increasing timestamps.
`mediaPeriodId: MediaSource.MediaPeriodId!`	The `MediaSource.MediaPeriodId` of the `MediaPeriod` that produces the stream.

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

releaseDecoder

@CallSuper
protected fun releaseDecoder(): Unit

Releases the decoder.

renderOutputBuffer

protected fun renderOutputBuffer(
    outputBuffer: VideoDecoderOutputBuffer!,
    presentationTimeUs: Long,
    outputFormat: Format!
): Unit

Renders the specified output buffer.

The implementation of this method takes ownership of the output buffer and is responsible for calling release either immediately or in the future.

Parameters
`outputBuffer: VideoDecoderOutputBuffer!`	`VideoDecoderOutputBuffer` to render.
`presentationTimeUs: Long`	Presentation time in microseconds.
`outputFormat: Format!`	Output `Format`.

Throws
`androidx.media3.decoder.DecoderException`	If an error occurs when rendering the output buffer.

renderOutputBufferToSurface

protected abstract fun renderOutputBufferToSurface(
    outputBuffer: VideoDecoderOutputBuffer!,
    surface: Surface!
): Unit

Renders the specified output buffer to the passed surface.

The implementation of this method takes ownership of the output buffer and is responsible for calling release either immediately or in the future.

Parameters
`outputBuffer: VideoDecoderOutputBuffer!`	`VideoDecoderOutputBuffer` to render.
`surface: Surface!`	Output `Surface`.

Throws
`androidx.media3.decoder.DecoderException`	If an error occurs when rendering the output buffer.

setDecoderOutputMode

protected abstract fun setDecoderOutputMode(@C.VideoOutputMode outputMode: Int): Unit

Sets output mode of the decoder.

Parameters
`@C.VideoOutputMode outputMode: Int`	Output mode.

setOutput

protected fun setOutput(output: Any?): Unit

Sets the video output.

shouldDropBuffersToKeyframe

protected fun shouldDropBuffersToKeyframe(earlyUs: Long, elapsedRealtimeUs: Long): Boolean

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

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

shouldDropOutputBuffer

protected fun shouldDropOutputBuffer(earlyUs: Long, elapsedRealtimeUs: Long): Boolean

Returns whether the buffer being processed should be dropped.

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

shouldForceRenderOutputBuffer

protected fun shouldForceRenderOutputBuffer(
    earlyUs: Long,
    elapsedSinceLastRenderUs: Long
): Boolean

Returns whether to force rendering an output buffer.

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

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

skipOutputBuffer

protected fun skipOutputBuffer(outputBuffer: VideoDecoderOutputBuffer!): Unit

Skips the specified output buffer and releases it.

Parameters
`outputBuffer: VideoDecoderOutputBuffer!`	The output buffer to skip.

updateDroppedBufferCounters

protected fun updateDroppedBufferCounters(
    droppedInputBufferCount: Int,
    droppedDecoderBufferCount: Int
): Unit

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

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

Protected properties

decoderCounters

protected val decoderCounters: DecoderCounters!

Decoder event counters used for debugging purposes.