MediaCodecAudioRenderer

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
public class MediaCodecAudioRenderer extends MediaCodecRenderer implements MediaClock

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

Decodes and renders audio using MediaCodec and an AudioSink.

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

Message with type MSG_SET_VOLUME to set the volume. The message payload should be a Float with 0 being silence and 1 being unity gain.
Message with type MSG_SET_AUDIO_ATTRIBUTES to set the audio attributes. The message payload should be an AudioAttributes instance that will configure the underlying audio track.
Message with type MSG_SET_AUX_EFFECT_INFO to set the auxiliary effect. The message payload should be an AuxEffectInfo instance that will configure the underlying audio track.
Message with type MSG_SET_SKIP_SILENCE_ENABLED to enable or disable skipping silences. The message payload should be a Boolean.
Message with type MSG_SET_AUDIO_SESSION_ID to set the audio session ID. The message payload should be a session ID Integer that will be attached to the underlying audio track.

Summary

Public constructors
`MediaCodecAudioRenderer( Context context, MediaCodecSelector mediaCodecSelector )`
`MediaCodecAudioRenderer( Context context, MediaCodecSelector mediaCodecSelector, @Nullable Handler eventHandler, @Nullable AudioRendererEventListener eventListener )`
`MediaCodecAudioRenderer( Context context, MediaCodecSelector mediaCodecSelector, @Nullable Handler eventHandler, @Nullable AudioRendererEventListener eventListener, AudioSink audioSink )`
`MediaCodecAudioRenderer( Context context, MediaCodecSelector mediaCodecSelector, boolean enableDecoderFallback, @Nullable Handler eventHandler, @Nullable AudioRendererEventListener eventListener, AudioSink audioSink )`
`MediaCodecAudioRenderer( Context context, MediaCodecSelector mediaCodecSelector, @Nullable Handler eventHandler, @Nullable AudioRendererEventListener eventListener, AudioCapabilities audioCapabilities, AudioProcessor[] audioProcessors )` This method is deprecated. Use a constructor without `AudioCapabilities`.
`MediaCodecAudioRenderer( Context context, MediaCodecAdapter.Factory codecAdapterFactory, MediaCodecSelector mediaCodecSelector, boolean enableDecoderFallback, @Nullable Handler eventHandler, @Nullable AudioRendererEventListener eventListener, AudioSink audioSink )` Creates a new instance.
`MediaCodecAudioRenderer( Context context, MediaCodecAdapter.Factory codecAdapterFactory, MediaCodecSelector mediaCodecSelector, boolean enableDecoderFallback, @Nullable Handler eventHandler, @Nullable AudioRendererEventListener eventListener, AudioSink audioSink, @Nullable LoudnessCodecController loudnessCodecController )` Creates a new instance.

Public methods
`long`	`getDurationToProgressUs( boolean isOnBufferAvailableListenerRegistered, long positionUs, long elapsedRealtimeUs )` Returns minimum time playback must advance in order for the `render` call to make progress.
`@Nullable MediaClock`	`getMediaClock()` If the renderer advances its own playback position then this method returns a corresponding `MediaClock`.
`String`	`getName()` Returns the name of this renderer, for logging and debugging purposes.
`PlaybackParameters`	`getPlaybackParameters()` Returns the active playback parameters.
`long`	`getPositionUs()` Returns the current media position in microseconds.
`void`	`handleMessage( @Renderer.MessageType int messageType, @Nullable Object message )` Handles a message delivered to the target.
`boolean`	`hasSkippedSilenceSinceLastCall()` Returns whether there is a skipped silence since the last call to this method.
`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`	`setPlaybackParameters(PlaybackParameters playbackParameters)` Attempts to set the playback parameters.

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.
`int`	`getCodecMaxInputSize( MediaCodecInfo codecInfo, Format format, Format[] streamFormats )` Returns a maximum input size suitable for configuring a codec for `format` in a way that will allow possible adaptation to other compatible formats in `streamFormats`.
`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.
`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, int codecMaxInputSize, float codecOperatingRate )` Returns the framework `MediaFormat` that can be used to configure a `MediaCodec` for decoding the given `Format` for playback.
`void`	`handleInputBufferSupplementalData(DecoderInputBuffer buffer)` Handles supplemental data associated with an input buffer.
`void`	`onCodecError(Exception codecError)` Called when a codec error has occurred.
`void`	`onCodecInitialized( String name, MediaCodecAdapter.Configuration configuration, long initializedTimestampMs, long initializationDurationMs )` Called when a `MediaCodec` has been created and configured.
`void`	`onCodecReleased(String name)` Called when a `MediaCodec` has been released.
`void`	`onDisabled()` Called when the renderer is disabled.
`void`	`onEnabled(boolean joining, boolean mayRenderStartOfStream)` Called when the renderer is enabled.
`@Nullable DecoderReuseEvaluation`	`onInputFormatChanged(FormatHolder formatHolder)` Called when a new `Format` is read from the upstream `MediaPeriod`.
`void`	`onOutputFormatChanged(Format format, @Nullable MediaFormat mediaFormat)` Called when one of the output formats changes.
`void`	`onOutputStreamOffsetUsChanged(long outputStreamOffsetUs)` Called after the output stream offset changes.
`void`	`@CallSuper onPositionDiscontinuity()` See `onPositionDiscontinuity`.
`void`	`onPositionReset(long positionUs, boolean joining)` Called when the position is reset.
`void`	`onProcessedStreamChange()` Called after the last output buffer before a stream change has been processed.
`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.
`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`	`renderToEndOfStream()` Incrementally renders any remaining output.
`boolean`	`shouldUseBypass(Format format)` Returns whether buffers in the input format can be processed without a codec.
`int`	`@RendererCapabilities.Capabilities supportsFormat(MediaCodecSelector mediaCodecSelector, Format format)` Returns the `Capabilities` for the given `Format`.

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`	`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`
`boolean`	`codecNeedsEosPropagation`
`float`	`codecOperatingRate`
`@Nullable MediaFormat`	`codecOutputMediaFormat`
`DecoderCounters`	`decoderCounters`
`long`	`lastBufferInStreamPresentationTimeUs`
`@Nullable Renderer.WakeupListener`	`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.
`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`.
`void`	`onInit()` Called when the renderer is initialized.
`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

`MediaCodecDecoderException`	`createDecoderException( Throwable cause, @Nullable MediaCodecInfo codecInfo )`
`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()`
`int`	`getCodecBufferFlags(DecoderInputBuffer buffer)` Returns the flags that should be set on `queueInputBuffer` or `queueSecureInputBuffer` for this buffer.
`final @Nullable MediaCodecInfo`	`getCodecInfo()`
`boolean`	`getCodecNeedsEosPropagation()` Returns whether the codec needs the renderer to propagate the end-of-stream signal directly, rather than by using an end-of-stream buffer queued to the codec.
`float`	`getCodecOperatingRate()` Returns the operating rate used by the current codec
`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`	`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`	`@CallSuper onProcessedOutputBuffer(long presentationTimeUs)` Called when an output buffer is successfully processed.
`void`	`onQueueInputBuffer(DecoderInputBuffer buffer)` Called immediately before an input buffer is queued into the codec.
`void`	`onReadyToInitializeCodec(Format format)` Called when ready to initialize the `MediaCodecAdapter`.
`void`	`onStreamChanged( Format[] formats, long startPositionUs, long offsetUs, MediaSource.MediaPeriodId mediaPeriodId )` Called when the renderer's stream has changed.
`void`	`releaseCodec()`
`void`	`render(long positionUs, long elapsedRealtimeUs)` Incrementally renders the `SampleStream`.
`void`	`@CallSuper resetCodecStateForFlush()` Resets the renderer internal state after a codec flush.
`void`	`@CallSuper resetCodecStateForRelease()` Resets the renderer internal state after a codec release.
`final void`	`setPendingOutputEndOfStream()` Notifies the renderer that output end of stream is pending and should be handled on the next render.
`final void`	`setPendingPlaybackException(ExoPlaybackException exception)` Sets an exception to be re-thrown by render.
`void`	`setPlaybackSpeed(float currentPlaybackSpeed, float targetPlaybackSpeed)` Indicates the playback speed to this renderer.
`void`	`setRenderTimeLimitMs(long renderTimeLimitMs)` Sets a limit on the time a single `render` call can spend draining and filling the decoder.
`boolean`	`shouldInitCodec(MediaCodecInfo codecInfo)`
`boolean`	`shouldReinitCodec()` Returns whether the renderer needs to re-initialize the codec, possibly as a result of a change in device capabilities.
`boolean`	`shouldSkipDecoderInputBuffer(DecoderInputBuffer buffer)` Returns whether the input buffer should be skipped before the decoder.
`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`.
`void`	`enableMayRenderStartOfStream()` Enables this renderer to render the start of the stream even if the state is not `STATE_STARTED` yet.
`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

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector
)

Parameters
`Context context`	A context.
`MediaCodecSelector mediaCodecSelector`	A decoder selector.

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener
)

Parameters
`Context context`	A context.
`MediaCodecSelector mediaCodecSelector`	A decoder selector.
`@Nullable Handler eventHandler`	A handler to use when delivering events to `eventListener`. May be null if delivery of events is not required.
`@Nullable AudioRendererEventListener eventListener`	A listener of events. May be null if delivery of events is not required.

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener,
    AudioSink audioSink
)

Parameters
`Context context`	A context.
`MediaCodecSelector mediaCodecSelector`	A decoder selector.
`@Nullable Handler eventHandler`	A handler to use when delivering events to `eventListener`. May be null if delivery of events is not required.
`@Nullable AudioRendererEventListener eventListener`	A listener of events. May be null if delivery of events is not required.
`AudioSink audioSink`	The sink to which audio will be output.

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener,
    AudioSink audioSink
)

Parameters
`Context context`	A context.
`MediaCodecSelector mediaCodecSelector`	A decoder selector.
`boolean enableDecoderFallback`	Whether to enable fallback to lower-priority decoders if decoder initialization fails. This may result in using a decoder that is slower/less efficient than the primary decoder.
`@Nullable Handler eventHandler`	A handler to use when delivering events to `eventListener`. May be null if delivery of events is not required.
`@Nullable AudioRendererEventListener eventListener`	A listener of events. May be null if delivery of events is not required.
`AudioSink audioSink`	The sink to which audio will be output.

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(
    Context context,
    MediaCodecSelector mediaCodecSelector,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener,
    AudioCapabilities audioCapabilities,
    AudioProcessor[] audioProcessors
)

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener,
    AudioSink audioSink
)

Creates a new instance.

Parameters
`Context context`	A context.
`MediaCodecAdapter.Factory codecAdapterFactory`	The `MediaCodecAdapter.Factory` used to create instances.
`MediaCodecSelector mediaCodecSelector`	A decoder selector.
`boolean enableDecoderFallback`	Whether to enable fallback to lower-priority decoders if decoder initialization fails. This may result in using a decoder that is slower/less efficient than the primary decoder.
`@Nullable Handler eventHandler`	A handler to use when delivering events to `eventListener`. May be null if delivery of events is not required.
`@Nullable AudioRendererEventListener eventListener`	A listener of events. May be null if delivery of events is not required.
`AudioSink audioSink`	The sink to which audio will be output.

MediaCodecAudioRenderer

public MediaCodecAudioRenderer(
    Context context,
    MediaCodecAdapter.Factory codecAdapterFactory,
    MediaCodecSelector mediaCodecSelector,
    boolean enableDecoderFallback,
    @Nullable Handler eventHandler,
    @Nullable AudioRendererEventListener eventListener,
    AudioSink audioSink,
    @Nullable LoudnessCodecController loudnessCodecController
)

Creates a new instance.

Parameters
`Context context`	A context.
`MediaCodecAdapter.Factory codecAdapterFactory`	The `MediaCodecAdapter.Factory` used to create instances.
`MediaCodecSelector mediaCodecSelector`	A decoder selector.
`boolean enableDecoderFallback`	Whether to enable fallback to lower-priority decoders if decoder initialization fails. This may result in using a decoder that is slower/less efficient than the primary decoder.
`@Nullable Handler eventHandler`	A handler to use when delivering events to `eventListener`. May be null if delivery of events is not required.
`@Nullable AudioRendererEventListener eventListener`	A listener of events. May be null if delivery of events is not required.
`AudioSink audioSink`	The sink to which audio will be output.
`@Nullable LoudnessCodecController loudnessCodecController`	The `LoudnessCodecController`, or null to not control loudness.

Public methods

getDurationToProgressUs

public long getDurationToProgressUs(
    boolean isOnBufferAvailableListenerRegistered,
    long positionUs,
    long elapsedRealtimeUs
)

Returns minimum time playback must advance in order for the render call to make progress.

If the Renderer has a registered , then the Renderer will be notified when decoder input and output buffers become available. These callbacks may affect the calculated minimum time playback must advance before a render call can make progress.

Parameters
`boolean isOnBufferAvailableListenerRegistered`	Whether the `Renderer` is using a with successfully registered OnBufferAvailableListener.
`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.

Returns
`long`	minimum time playback must advance before renderer is able to make progress.

getMediaClock

public @Nullable MediaClock getMediaClock()

If the renderer advances its own playback position then this method returns a corresponding MediaClock. If provided, the player will use the returned MediaClock as its source of time during playback. A player may have at most one renderer that returns a from this method.

Returns
`@Nullable MediaClock`	The `MediaClock` tracking the playback position of the renderer, or null.

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.

getPlaybackParameters

public PlaybackParameters getPlaybackParameters()

Returns the active playback parameters.

getPositionUs

public long getPositionUs()

Returns the current media position in microseconds.

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.

hasSkippedSilenceSinceLastCall

public boolean hasSkippedSilenceSinceLastCall()

Returns whether there is a skipped silence since the last call to this method.

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.

setPlaybackParameters

public void setPlaybackParameters(PlaybackParameters playbackParameters)

Attempts to set the playback parameters. The media clock may override the speed if changing the playback parameters is not supported.

Parameters
`PlaybackParameters playbackParameters`	The playback parameters to attempt to set.

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.

getCodecMaxInputSize

protected int getCodecMaxInputSize(
    MediaCodecInfo codecInfo,
    Format format,
    Format[] streamFormats
)

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

Parameters
`MediaCodecInfo codecInfo`	A `MediaCodecInfo` describing the decoder.
`Format format`	The `Format` for which the codec is being configured.
`Format[] streamFormats`	The possible stream formats.

Returns
`int`	A suitable maximum input size.

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.

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,
    int codecMaxInputSize,
    float codecOperatingRate
)

Returns the framework MediaFormat that can be used to configure a MediaCodec for decoding the given Format for playback.

Parameters
`Format format`	The `Format` of the media.
`String codecMimeType`	The MIME type handled by the codec.
`int codecMaxInputSize`	The maximum input size supported by the codec.
`float codecOperatingRate`	The codec operating rate, or `CODEC_OPERATING_RATE_UNSET` if no codec operating rate should be set.

Returns
`MediaFormat`	The framework `MediaFormat`.

handleInputBufferSupplementalData

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.

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.

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.

onOutputStreamOffsetUsChanged

protected void onOutputStreamOffsetUsChanged(long outputStreamOffsetUs)

Called after the output stream offset changes.

The default implementation is a no-op.

Parameters
`long outputStreamOffsetUs`	The output stream offset in microseconds.

onPositionDiscontinuity

@CallSuper
protected void onPositionDiscontinuity()

See onPositionDiscontinuity.

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.

onProcessedStreamChange

protected void onProcessedStreamChange()

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

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.

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.

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.

shouldUseBypass

protected boolean shouldUseBypass(Format format)

Returns whether buffers in the input format can be processed without a codec.

This method is only called if the content is not DRM protected, because if the content is DRM protected use of bypass is never possible.

Parameters
`Format format`	The input `Format`.

Returns
`boolean`	Whether playback bypassing `MediaCodec` is supported.

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.