DecoderAudioRenderer

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
abstract class DecoderAudioRenderer<T : Decoder<DecoderInputBuffer!, SimpleDecoderOutputBuffer!, DecoderException!>?> : BaseRenderer, MediaClock

kotlin.Any
↳	androidx.media3.exoplayer.BaseRenderer
	↳	androidx.media3.exoplayer.audio.DecoderAudioRenderer

Decodes and renders audio using a Decoder.

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_PREFERRED_AUDIO_DEVICE to set the preferred audio output device. The message payload should be an AudioDeviceInfo instance.
Message with type MSG_SET_VIRTUAL_DEVICE_ID to set the virtual device id. The message payload should be an Integer for the virtual device id or INDEX_UNSET if unspecified.
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.
Message with type MSG_SET_AUDIO_OUTPUT_PROVIDER to set the audio output provider. The message payload must be an AudioOutputProvider instance.

Summary

Public constructors
`DecoderAudioRenderer()`
`DecoderAudioRenderer( eventHandler: Handler?, eventListener: AudioRendererEventListener?, audioProcessors: Array<AudioProcessor!>! )`
`DecoderAudioRenderer( eventHandler: Handler?, eventListener: AudioRendererEventListener?, audioSink: AudioSink! )`
`DecoderAudioRenderer( eventHandler: Handler?, eventListener: AudioRendererEventListener?, audioCapabilities: AudioCapabilities!, audioProcessors: Array<AudioProcessor!>! )`

Public functions
`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.
`MediaClock?`	`getMediaClock()` If the renderer advances its own playback position then this method returns a corresponding `MediaClock`.
`PlaybackParameters!`	`getPlaybackParameters()` Returns the active playback parameters.
`Long`	`getPositionUs()` Returns the current media position in microseconds.
`Unit`	`handleMessage(@Renderer.MessageType messageType: Int, message: Any?)` 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.
`Unit`	`render(positionUs: Long, elapsedRealtimeUs: Long)` Incrementally renders the `SampleStream`.
`Unit`	`setPlaybackParameters(playbackParameters: PlaybackParameters!)` Attempts to set the playback parameters.
`Int`	`@RendererCapabilities.Capabilities supportsFormat(format: Format!)` Returns the extent to which the `Renderer` supports a given format.

Protected functions
`DecoderReuseEvaluation!`	`@ForOverride canReuseDecoder(decoderName: String!, oldFormat: Format!, newFormat: Format!)` Evaluates whether the existing decoder can be reused for a new `Format`.
`abstract T!`	`@ForOverride createDecoder(format: Format!, cryptoConfig: CryptoConfig?)` Creates a decoder for the given format.
`IntArray<Int>?`	`@ForOverride getChannelMapping(decoder: T!)` Returns the channel layout mapping that should be applied when sending this data to the output, or null to not change the channel layout.
`abstract Format!`	`@ForOverride getOutputFormat(decoder: T!)` Returns the format of audio buffers output by the decoder.
`Int`	`@AudioSink.SinkFormatSupport getSinkFormatSupport(format: Format!)` Returns the level of support that the renderer's `AudioSink` provides for a given `Format`.
`Boolean`	`isReadyForDecoding()` Returns whether the renderer is ready to start or continue decoding.
`Unit`	`onDisabled()` Called when the renderer is disabled.
`Unit`	`onEnabled(joining: Boolean, mayRenderStartOfStream: Boolean)` Called when the renderer is enabled.
`Unit`	`@CallSuper @ForOverride onPositionDiscontinuity()` See `onPositionDiscontinuity`.
`Unit`	`onPositionReset( positionUs: Long, joining: Boolean, sampleStreamIsResetToKeyFrame: Boolean )` Called when the position is reset.
`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.
`Boolean`	`sinkSupportsFormat(format: Format!)` Returns whether the renderer's `AudioSink` supports a given `Format`.
`abstract Int`	`@ForOverride @C.FormatSupport supportsFormatInternal(format: Format!)` Returns the `C.FormatSupport` for the given `Format`.

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 Long`	`DEFAULT_IDLE_DURATION_TO_PROGRESS_US = 1000000` Default duration to progress reported if the renderer does not need calls to `render` to progress, if it's in `STATE_ENABLED` and already `ready` or `ended`.
`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_OUTPUT_PROVIDER = 20` The type of a message that can be passed to audio renderers 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_SCRUBBING_MODE = 18` The type of message that can be passed to a renderer to direct it to enable or disable scrubbing mode.
`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_VIRTUAL_DEVICE_ID = 19` The type of a message that can be passed to audio renderers via `createMessage`.
`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`	`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.
`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.
`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, sampleStreamIsResetToKeyFrame: Boolean)` 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`.
`Unit`	`enableMayRenderStartOfStream()` Enables this renderer to render the start of the stream even if the state is not `STATE_STARTED` yet.
`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.
`Boolean`	`supportsResetPositionWithoutKeyFrameReset(positionUs: Long)` Returns whether the renderer can support processing a position discontinuity without a key frame reset.

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`, `AdaptiveSupport` 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`, `AdaptiveSupport`, `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`, `AdaptiveSupport`, `TunnelingSupport`, `HardwareAccelerationSupport`, and `DecoderSupport`.
`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`, `AdaptiveSupport`, `TunnelingSupport`, `HardwareAccelerationSupport`, `DecoderSupport` 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`.

Inherited properties

From androidx.media3.exoplayer.BaseRenderer

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

Public constructors

DecoderAudioRenderer

DecoderAudioRenderer()

DecoderAudioRenderer

DecoderAudioRenderer(
    eventHandler: Handler?,
    eventListener: AudioRendererEventListener?,
    audioProcessors: Array<AudioProcessor!>!
)

Parameters
`eventHandler: Handler?`	A handler to use when delivering events to `eventListener`. May be null if delivery of events is not required.
`eventListener: AudioRendererEventListener?`	A listener of events. May be null if delivery of events is not required.
`audioProcessors: Array<AudioProcessor!>!`	Optional `AudioProcessor`s that will process audio before output.

DecoderAudioRenderer

DecoderAudioRenderer(
    eventHandler: Handler?,
    eventListener: AudioRendererEventListener?,
    audioSink: AudioSink!
)

Parameters
`eventHandler: Handler?`	A handler to use when delivering events to `eventListener`. May be null if delivery of events is not required.
`eventListener: AudioRendererEventListener?`	A listener of events. May be null if delivery of events is not required.
`audioSink: AudioSink!`	The sink to which audio will be output.

DecoderAudioRenderer

DecoderAudioRenderer(
    eventHandler: Handler?,
    eventListener: AudioRendererEventListener?,
    audioCapabilities: AudioCapabilities!,
    audioProcessors: Array<AudioProcessor!>!
)

Parameters
`eventHandler: Handler?`	A handler to use when delivering events to `eventListener`. May be null if delivery of events is not required.
`eventListener: AudioRendererEventListener?`	A listener of events. May be null if delivery of events is not required.
`audioCapabilities: AudioCapabilities!`	The audio capabilities for playback on this device. Use `DEFAULT_AUDIO_CAPABILITIES` if default capabilities (no encoded audio passthrough support) should be assumed.
`audioProcessors: Array<AudioProcessor!>!`	Optional `AudioProcessor`s that will process audio before output.

Public functions

getDurationToProgressUs

fun getDurationToProgressUs(positionUs: Long, elapsedRealtimeUs: Long): Long

Returns minimum amount of playback clock time that must pass in order for the render call to make progress.

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

The default return time is DEFAULT_DURATION_TO_PROGRESS_US if the renderer is in STATE_STARTED, or in STATE_ENABLED and not yet ready or ended. Otherwise, it returns DEFAULT_IDLE_DURATION_TO_PROGRESS_US.

Parameters
`positionUs: Long`	The current render position 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.

Returns
`Long`	Minimum amount of playback clock time that must pass before renderer is able to make progress.

getMediaClock

fun getMediaClock(): MediaClock?

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 MediaClock from this method.

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

getPlaybackParameters

fun getPlaybackParameters(): PlaybackParameters!

Returns the active playback parameters.

getPositionUs

fun getPositionUs(): Long

Returns the current media position in microseconds.

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.

hasSkippedSilenceSinceLastCall

fun hasSkippedSilenceSinceLastCall(): Boolean

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

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.

setPlaybackParameters

fun setPlaybackParameters(playbackParameters: PlaybackParameters!): Unit

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.

supportsFormat

@RendererCapabilities.Capabilities
fun supportsFormat(format: Format!): Int

Returns the extent to which the Renderer supports a given format.

Parameters
`format: Format!`	The format.

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

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

Protected functions

canReuseDecoder

@ForOverride
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

@ForOverride
protected abstract fun createDecoder(format: Format!, cryptoConfig: CryptoConfig?): T!

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
`T!`	The decoder.

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

getChannelMapping

@ForOverride
protected fun getChannelMapping(decoder: T!): IntArray<Int>?

Returns the channel layout mapping that should be applied when sending this data to the output, or null to not change the channel layout.

Parameters
`decoder: T!`	The decoder.

getOutputFormat

@ForOverride
protected abstract fun getOutputFormat(decoder: T!): Format!

Returns the format of audio buffers output by the decoder. Will not be called until the first output buffer has been dequeued, so the decoder may use input data to determine the format.

Parameters
`decoder: T!`	The decoder.

getSinkFormatSupport

@AudioSink.SinkFormatSupport
protected fun getSinkFormatSupport(format: Format!): Int

Returns the level of support that the renderer's AudioSink provides for a given Format.

See also
`getFormatSupport`	(Format)

isReadyForDecoding

protected fun isReadyForDecoding(): Boolean

Returns whether the renderer is ready to start or continue decoding.

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.

onPositionDiscontinuity

@CallSuper
@ForOverride
protected fun onPositionDiscontinuity(): Unit

See onPositionDiscontinuity.

onPositionReset

protected fun onPositionReset(
    positionUs: Long,
    joining: Boolean,
    sampleStreamIsResetToKeyFrame: 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 if sampleStreamIsResetToKeyFrame is true. sampleStreamIsResetToKeyFrame is guaranteed to be true unless the implementation overrides supportsResetPositionWithoutKeyFrameReset to return true.

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.
`sampleStreamIsResetToKeyFrame: Boolean`	Whether the renderer's `SampleStream` is guaranteed to provide samples starting from a key frame.

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

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.

sinkSupportsFormat

protected fun sinkSupportsFormat(format: Format!): Boolean

Returns whether the renderer's AudioSink supports a given Format.

See also
`supportsFormat`

supportsFormatInternal

@ForOverride
@C.FormatSupport
protected abstract fun supportsFormatInternal(format: Format!): Int

Returns the C.FormatSupport for the given Format.

Parameters
`format: Format!`	The format, which has an audio `sampleMimeType`.

Returns
`Int`	The `C.FormatSupport` for this `Format`.