DecoderAudioRenderer (ExoPlayer library)

Package com.google.android.exoplayer2.audio

Class DecoderAudioRenderer<T extends Decoder<DecoderInputBuffer,​? extends SimpleDecoderOutputBuffer,​? extends DecoderException>>

• java.lang.Object

• • com.google.android.exoplayer2.BaseRenderer
  • • com.google.android.exoplayer2.audio.DecoderAudioRenderer<T>

• All Implemented Interfaces:PlayerMessage.Target, Renderer, RendererCapabilities, MediaClockDirect Known Subclasses:FfmpegAudioRenderer, LibflacAudioRenderer, LibopusAudioRenderer

[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public abstract classDecoderAudioRenderer\<T extends [Decoder](../decoder/Decoder.html "interface in com.google.android.exoplayer2.decoder")\<[DecoderInputBuffer](../decoder/DecoderInputBuffer.html "class in com.google.android.exoplayer2.decoder"),​? extends [SimpleDecoderOutputBuffer](../decoder/SimpleDecoderOutputBuffer.html "class in com.google.android.exoplayer2.decoder"),​? extends [DecoderException](../decoder/DecoderException.html "class in com.google.android.exoplayer2.decoder")\>\>extends[BaseRenderer](../BaseRenderer.html "class in com.google.android.exoplayer2")implements[MediaClock](../util/MediaClock.html "interface in com.google.android.exoplayer2.util")

Deprecated. com.google.android.exoplayer2 is deprecated. Please migrate to androidx.media3 (which contains the same ExoPlayer code). See the migration guide for more details, including a script to help with the migration.

Decodes and renders audio using a Decoder.

This renderer accepts the following messages sent via ExoPlayer.createMessage(Target) on the playback thread:

• Message with type Renderer.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 Renderer.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 Renderer.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 Renderer.MSG_SET_SKIP_SILENCE_ENABLED to enable or disable skipping silences. The message payload should be a Boolean.

• Message with type Renderer.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.

Nested Class Summary

- 

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.Renderer

Renderer.MessageType, Renderer.State, Renderer.WakeupListener

- 

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.RendererCapabilities

RendererCapabilities.AdaptiveSupport, RendererCapabilities.Capabilities, RendererCapabilities.DecoderSupport, RendererCapabilities.FormatSupport, RendererCapabilities.HardwareAccelerationSupport, RendererCapabilities.Listener, RendererCapabilities.TunnelingSupport

Field Summary

- 

Fields inherited from interface com.google.android.exoplayer2.Renderer

MSG_CUSTOM_BASE, MSG_SET_AUDIO_ATTRIBUTES, MSG_SET_AUDIO_SESSION_ID, MSG_SET_AUX_EFFECT_INFO, MSG_SET_CAMERA_MOTION_LISTENER, MSG_SET_CHANGE_FRAME_RATE_STRATEGY, MSG_SET_PREFERRED_AUDIO_DEVICE, MSG_SET_SCALING_MODE, MSG_SET_SKIP_SILENCE_ENABLED, MSG_SET_VIDEO_EFFECTS, MSG_SET_VIDEO_FRAME_METADATA_LISTENER, MSG_SET_VIDEO_OUTPUT, MSG_SET_VIDEO_OUTPUT_RESOLUTION, MSG_SET_VOLUME, MSG_SET_WAKEUP_LISTENER, STATE_DISABLED, STATE_ENABLED, STATE_STARTED

- 

Fields inherited from interface com.google.android.exoplayer2.RendererCapabilities

ADAPTIVE_NOT_SEAMLESS, ADAPTIVE_NOT_SUPPORTED, ADAPTIVE_SEAMLESS, ADAPTIVE_SUPPORT_MASK, DECODER_SUPPORT_FALLBACK, DECODER_SUPPORT_FALLBACK_MIMETYPE, DECODER_SUPPORT_PRIMARY, FORMAT_EXCEEDS_CAPABILITIES, FORMAT_HANDLED, FORMAT_SUPPORT_MASK, FORMAT_UNSUPPORTED_DRM, FORMAT_UNSUPPORTED_SUBTYPE, FORMAT_UNSUPPORTED_TYPE, HARDWARE_ACCELERATION_NOT_SUPPORTED, HARDWARE_ACCELERATION_SUPPORT_MASK, HARDWARE_ACCELERATION_SUPPORTED, MODE_SUPPORT_MASK, TUNNELING_NOT_SUPPORTED, TUNNELING_SUPPORT_MASK, TUNNELING_SUPPORTED

Constructor Summary

Constructors | Constructor | Description | | --- | --- | | DecoderAudioRenderer() | Deprecated. | | DecoderAudioRenderer​(Handler eventHandler, AudioRendererEventListener eventListener, AudioCapabilities audioCapabilities, AudioProcessor... audioProcessors) | Deprecated. | | DecoderAudioRenderer​(Handler eventHandler, AudioRendererEventListener eventListener, AudioProcessor... audioProcessors) | Deprecated. | | DecoderAudioRenderer​(Handler eventHandler, AudioRendererEventListener eventListener, AudioSink audioSink) | Deprecated. |

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods | Modifier and Type | Method | Description | | --- | --- | --- | | protected DecoderReuseEvaluation | canReuseDecoder​(String decoderName, Format oldFormat, Format newFormat) | Deprecated.

Evaluates whether the existing decoder can be reused for a new Format. | | protected abstract T | createDecoder​(Format format, CryptoConfig cryptoConfig) | Deprecated.

Creates a decoder for the given format. | | void | experimentalSetEnableKeepAudioTrackOnSeek​(boolean enableKeepAudioTrackOnSeek) | Deprecated.

Sets whether to enable the experimental feature that keeps and flushes the AudioTrack when a seek occurs, as opposed to releasing and reinitialising. | | MediaClock | getMediaClock() | Deprecated.

If the renderer advances its own playback position then this method returns a corresponding MediaClock. | | protected abstract Format | getOutputFormat​(T decoder) | Deprecated.

Returns the format of audio buffers output by the decoder. | | PlaybackParameters | getPlaybackParameters() | Deprecated.

Returns the active playback parameters. | | long | getPositionUs() | Deprecated.

Returns the current media position in microseconds. | | protected @com.google.android.exoplayer2.audio.AudioSink.SinkFormatSupport int | getSinkFormatSupport​(Format format) | Deprecated.

Returns the level of support that the renderer's AudioSink provides for a given Format. | | void | handleMessage​(@com.google.android.exoplayer2.Renderer.MessageType int messageType, Object message) | Deprecated.

Handles a message delivered to the target. | | boolean | isEnded() | Deprecated.

Whether the renderer is ready for the ExoPlayer instance to transition to Player.STATE_ENDED. | | boolean | isReady() | Deprecated.

Whether the renderer is able to immediately render media from the current position. | | protected void | onDisabled() | Deprecated.

Called when the renderer is disabled. | | protected void | onEnabled​(boolean joining, boolean mayRenderStartOfStream) | Deprecated.

Called when the renderer is enabled. | | protected void | onPositionDiscontinuity() | Deprecated.

See AudioSink.Listener.onPositionDiscontinuity(). | | protected void | onPositionReset​(long positionUs, boolean joining) | Deprecated.

Called when the position is reset. | | protected void | onQueueInputBuffer​(DecoderInputBuffer buffer) | Deprecated. | | protected void | onStarted() | Deprecated.

Called when the renderer is started. | | protected void | onStopped() | Deprecated.

Called when the renderer is stopped. | | protected void | onStreamChanged​(Format[] formats, long startPositionUs, long offsetUs) | Deprecated.

Called when the renderer's stream has changed. | | void | render​(long positionUs, long elapsedRealtimeUs) | Deprecated.

Incrementally renders the SampleStream. | | void | setPlaybackParameters​(PlaybackParameters playbackParameters) | Deprecated.

Attempts to set the playback parameters. | | protected boolean | sinkSupportsFormat​(Format format) | Deprecated.

Returns whether the renderer's AudioSink supports a given Format. | | @com.google.android.exoplayer2.RendererCapabilities.Capabilities int | supportsFormat​(Format format) | Deprecated.

Returns the extent to which the Renderer supports a given format. | | protected abstract @com.google.android.exoplayer2.C.FormatSupport int | supportsFormatInternal​(Format format) | Deprecated.

Returns the C.FormatSupport for the given Format. |

- 

Methods inherited from class com.google.android.exoplayer2.BaseRenderer

clearListener, createRendererException, createRendererException, disable, enable, getCapabilities, getConfiguration, getFormatHolder, getIndex, getLastResetPositionUs, getPlayerId, getReadingPositionUs, getState, getStream, getStreamFormats, getTrackType, hasReadStreamToEnd, init, isCurrentStreamFinal, isSourceReady, maybeThrowStreamError, onRelease, onRendererCapabilitiesChanged, onReset, readSource, release, replaceStream, reset, resetPosition, setCurrentStreamFinal, setListener, skipSource, start, stop, supportsMixedMimeTypeAdaptation

- 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 

Methods inherited from interface com.google.android.exoplayer2.Renderer

getName, setPlaybackSpeed

- 

Methods inherited from interface com.google.android.exoplayer2.RendererCapabilities

getName

Constructor Detail

- 

DecoderAudioRenderer

public DecoderAudioRenderer()

Deprecated.

- 

DecoderAudioRenderer

public DecoderAudioRenderer​(@Nullable[Handler](https://developer.android.com/reference/android/os/Handler.html "class or interface in android.os")eventHandler,
                            @Nullable[AudioRendererEventListener](AudioRendererEventListener.html "interface in com.google.android.exoplayer2.audio")eventListener,[AudioProcessor](AudioProcessor.html "interface in com.google.android.exoplayer2.audio")... audioProcessors)

Deprecated. Parameters:eventHandler - A handler to use when delivering events to eventListener. May be null if delivery of events is not required.eventListener - A listener of events. May be null if delivery of events is not required.audioProcessors - Optional AudioProcessors that will process audio before output.

- 

DecoderAudioRenderer

public DecoderAudioRenderer​(@Nullable[Handler](https://developer.android.com/reference/android/os/Handler.html "class or interface in android.os")eventHandler,
                            @Nullable[AudioRendererEventListener](AudioRendererEventListener.html "interface in com.google.android.exoplayer2.audio")eventListener,[AudioCapabilities](AudioCapabilities.html "class in com.google.android.exoplayer2.audio")audioCapabilities,[AudioProcessor](AudioProcessor.html "interface in com.google.android.exoplayer2.audio")... audioProcessors)

Deprecated. Parameters:eventHandler - A handler to use when delivering events to eventListener. May be null if delivery of events is not required.eventListener - A listener of events. May be null if delivery of events is not required.audioCapabilities - The audio capabilities for playback on this device. Use AudioCapabilities.DEFAULT_AUDIO_CAPABILITIES if default capabilities (no encoded audio passthrough support) should be assumed.audioProcessors - Optional AudioProcessors that will process audio before output.

- 

DecoderAudioRenderer

public DecoderAudioRenderer​(@Nullable[Handler](https://developer.android.com/reference/android/os/Handler.html "class or interface in android.os")eventHandler,
                            @Nullable[AudioRendererEventListener](AudioRendererEventListener.html "interface in com.google.android.exoplayer2.audio")eventListener,[AudioSink](AudioSink.html "interface in com.google.android.exoplayer2.audio")audioSink)

Deprecated. Parameters:eventHandler - A handler to use when delivering events to eventListener. May be null if delivery of events is not required.eventListener - A listener of events. May be null if delivery of events is not required.audioSink - The sink to which audio will be output.

Method Detail

- 

experimentalSetEnableKeepAudioTrackOnSeek

public void experimentalSetEnableKeepAudioTrackOnSeek​(boolean enableKeepAudioTrackOnSeek)

Deprecated.

Sets whether to enable the experimental feature that keeps and flushes the AudioTrack when a seek occurs, as opposed to releasing and reinitialising. Off by default.

This method is experimental, and will be renamed or removed in a future release.

Parameters:enableKeepAudioTrackOnSeek - Whether to keep the AudioTrack on seek.

- 

getMediaClock

@Nullable
public[MediaClock](../util/MediaClock.html "interface in com.google.android.exoplayer2.util")getMediaClock()

Deprecated.

Description copied from interface: Renderer

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. Specified by:getMediaClock in interface RendererOverrides:getMediaClock in class BaseRendererReturns:The MediaClock tracking the playback position of the renderer, or null.

- 

supportsFormat

public final @com.google.android.exoplayer2.RendererCapabilities.Capabilities int supportsFormat​([Format](../Format.html "class in com.google.android.exoplayer2")format)

Deprecated.

Description copied from interface: RendererCapabilities

Returns the extent to which the Renderer supports a given format. Specified by:supportsFormat in interface RendererCapabilitiesParameters:format - The format.Returns:The RendererCapabilities.Capabilities for this format.

- 

supportsFormatInternal

@ForOverride[@FormatSupport](../C.FormatSupport.html "annotation in com.google.android.exoplayer2")protected abstract @com.google.android.exoplayer2.C.FormatSupport int supportsFormatInternal​([Format](../Format.html "class in com.google.android.exoplayer2")format)

Deprecated.

Returns the C.FormatSupport for the given Format. Parameters:format - The format, which has an audio Format.sampleMimeType.Returns:The C.FormatSupport for this Format.

- 

sinkSupportsFormat

protected final boolean sinkSupportsFormat​([Format](../Format.html "class in com.google.android.exoplayer2")format)

Deprecated.

Returns whether the renderer's AudioSink supports a given Format. See Also:AudioSink.supportsFormat(Format)

- 

getSinkFormatSupport

protected final @com.google.android.exoplayer2.audio.AudioSink.SinkFormatSupport int getSinkFormatSupport​([Format](../Format.html "class in com.google.android.exoplayer2")format)

Deprecated.

Returns the level of support that the renderer's AudioSink provides for a given Format. See Also:(Format)

- 

render

public void render​(long positionUs,
                   long elapsedRealtimeUs)
            throws[ExoPlaybackException](../ExoPlaybackException.html "class in com.google.android.exoplayer2")

Deprecated.

Description copied from interface: Renderer

Incrementally renders the SampleStream.

If the renderer is in the Renderer.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 Renderer.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 Renderer.STATE_ENABLED state, unless it's the initial start of the media after calling Renderer.enable(RendererConfiguration, Format[], SampleStream, long, boolean, boolean, long, long) 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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.

Specified by:render in interface RendererParameters:positionUs - The current media time in microseconds, measured at the start of the current iteration of the rendering loop.elapsedRealtimeUs - SystemClock.elapsedRealtime() in microseconds, measured at the start of the current iteration of the rendering loop.Throws:ExoPlaybackException - If an error occurs.

- 

onPositionDiscontinuity

@CallSuper
@ForOverride
protected void onPositionDiscontinuity()

Deprecated.

See AudioSink.Listener.onPositionDiscontinuity().

- 

createDecoder

@ForOverride
protected abstract[T](DecoderAudioRenderer.html "type parameter in DecoderAudioRenderer")createDecoder​([Format](../Format.html "class in com.google.android.exoplayer2")format,
                                   @Nullable[CryptoConfig](../decoder/CryptoConfig.html "interface in com.google.android.exoplayer2.decoder")cryptoConfig)
                            throws[DecoderException](../decoder/DecoderException.html "class in com.google.android.exoplayer2.decoder")

Deprecated.

Creates a decoder for the given format. Parameters:format - The format for which a decoder is required.cryptoConfig - The CryptoConfig object required for decoding encrypted content. May be null and can be ignored if decoder does not handle encrypted content.Returns:The decoder.Throws:DecoderException - If an error occurred creating a suitable decoder.

- 

getOutputFormat

@ForOverride
protected abstract[Format](../Format.html "class in com.google.android.exoplayer2")getOutputFormat​([T](DecoderAudioRenderer.html "type parameter in DecoderAudioRenderer")decoder)

Deprecated.

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 - The decoder.

- 

canReuseDecoder

@ForOverride
protected[DecoderReuseEvaluation](../decoder/DecoderReuseEvaluation.html "class in com.google.android.exoplayer2.decoder")canReuseDecoder​([String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")decoderName,[Format](../Format.html "class in com.google.android.exoplayer2")oldFormat,[Format](../Format.html "class in com.google.android.exoplayer2")newFormat)

Deprecated.

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

The default implementation does not allow decoder reuse.

Parameters:decoderName - The name of the decoder.oldFormat - The previous format.newFormat - The new format.Returns:The result of the evaluation.

- 

isEnded

public boolean isEnded()

Deprecated.

Description copied from interface: Renderer

Whether the renderer is ready for the ExoPlayer instance to transition to Player.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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.

Specified by:isEnded in interface RendererReturns:Whether the renderer is ready for the player to transition to the ended state.

- 

isReady

public boolean isReady()

Deprecated.

Description copied from interface: Renderer

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

If the renderer is in the Renderer.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 Renderer.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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.

Specified by:isReady in interface RendererReturns:Whether the renderer is ready to render media.

- 

getPositionUs

public long getPositionUs()

Deprecated.

Description copied from interface: MediaClock

Returns the current media position in microseconds. Specified by:getPositionUs in interface MediaClock

- 

setPlaybackParameters

public void setPlaybackParameters​([PlaybackParameters](../PlaybackParameters.html "class in com.google.android.exoplayer2")playbackParameters)

Deprecated.

Description copied from interface: MediaClock

Attempts to set the playback parameters. The media clock may override the speed if changing the playback parameters is not supported. Specified by:setPlaybackParameters in interface MediaClockParameters:playbackParameters - The playback parameters to attempt to set.

- 

getPlaybackParameters

public[PlaybackParameters](../PlaybackParameters.html "class in com.google.android.exoplayer2")getPlaybackParameters()

Deprecated.

Description copied from interface: MediaClock

Returns the active playback parameters. Specified by:getPlaybackParameters in interface MediaClock

- 

onEnabled

protected void onEnabled​(boolean joining,
                         boolean mayRenderStartOfStream)
                  throws[ExoPlaybackException](../ExoPlaybackException.html "class in com.google.android.exoplayer2")

Deprecated.

Description copied from class: BaseRenderer

Called when the renderer is enabled.

The default implementation is a no-op.

Overrides:onEnabled in class BaseRendererParameters:joining - Whether this renderer is being enabled to join an ongoing playback.mayRenderStartOfStream - Whether this renderer is allowed to render the start of the stream even if the state is not Renderer.STATE_STARTED yet.Throws:ExoPlaybackException - If an error occurs.

- 

onPositionReset

protected void onPositionReset​(long positionUs,
                               boolean joining)
                        throws[ExoPlaybackException](../ExoPlaybackException.html "class in com.google.android.exoplayer2")

Deprecated.

Description copied from class: BaseRenderer

Called when the position is reset. This occurs when the renderer is enabled after BaseRenderer.onStreamChanged(Format[], long, long) 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.

Overrides:onPositionReset in class BaseRendererParameters:positionUs - The new playback position in microseconds.joining - Whether this renderer is being enabled to join an ongoing playback.Throws:ExoPlaybackException - If an error occurs.

- 

onStarted

protected void onStarted()

Deprecated.

Description copied from class: BaseRenderer

Called when the renderer is started.

The default implementation is a no-op.

Overrides:onStarted in class BaseRenderer

- 

onStopped

protected void onStopped()

Deprecated.

Description copied from class: BaseRenderer

Called when the renderer is stopped.

The default implementation is a no-op.

Overrides:onStopped in class BaseRenderer

- 

onDisabled

protected void onDisabled()

Deprecated.

Description copied from class: BaseRenderer

Called when the renderer is disabled.

The default implementation is a no-op.

Overrides:onDisabled in class BaseRenderer

- 

onStreamChanged

protected void onStreamChanged​([Format](../Format.html "class in com.google.android.exoplayer2")[] formats,
                               long startPositionUs,
                               long offsetUs)
                        throws[ExoPlaybackException](../ExoPlaybackException.html "class in com.google.android.exoplayer2")

Deprecated.

Description copied from class: BaseRenderer

Called when the renderer's stream has changed. This occurs when the renderer is enabled after BaseRenderer.onEnabled(boolean, boolean) 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.

Overrides:onStreamChanged in class BaseRendererParameters:formats - The enabled formats.startPositionUs - The start position of the new stream in renderer time (microseconds).offsetUs - The offset that will be added to the timestamps of buffers read via BaseRenderer.readSource(com.google.android.exoplayer2.FormatHolder, com.google.android.exoplayer2.decoder.DecoderInputBuffer, @com.google.android.exoplayer2.source.SampleStream.ReadFlags int) so that decoder input buffers have monotonically increasing timestamps.Throws:ExoPlaybackException - If an error occurs.

- 

handleMessage

public void handleMessage​(@com.google.android.exoplayer2.Renderer.MessageType int messageType,
                          @Nullable[Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")message)
                   throws[ExoPlaybackException](../ExoPlaybackException.html "class in com.google.android.exoplayer2")

Deprecated.

Description copied from interface: PlayerMessage.Target

Handles a message delivered to the target. Specified by:handleMessage in interface PlayerMessage.TargetOverrides:handleMessage in class BaseRendererParameters:messageType - The message type.message - The message payload.Throws:ExoPlaybackException - If an error occurred whilst handling the message. Should only be thrown by targets that handle messages on the playback thread.

- 

onQueueInputBuffer

protected void onQueueInputBuffer​([DecoderInputBuffer](../decoder/DecoderInputBuffer.html "class in com.google.android.exoplayer2.decoder")buffer)

Deprecated.