DecoderAudioRenderer (ExoPlayer library)

java.lang.Object
- com.google.android.exoplayer2.BaseRenderer
- - com.google.android.exoplayer2.audio.DecoderAudioRenderer<T>

All Implemented Interfaces:

PlayerMessage.Target, Renderer, RendererCapabilities, MediaClock

Direct Known Subclasses:

FfmpegAudioRenderer, LibflacAudioRenderer, LibopusAudioRenderer
```
public abstract class DecoderAudioRenderer<T extends Decoder<DecoderInputBuffer,? extends SimpleOutputBuffer,? extends DecoderException>>
extends BaseRenderer
implements MediaClock
```
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.State, Renderer.VideoScalingMode, Renderer.WakeupListener
- Nested classes/interfaces inherited from interface com.google.android.exoplayer2.RendererCapabilities
  RendererCapabilities.AdaptiveSupport, RendererCapabilities.Capabilities, RendererCapabilities.FormatSupport, 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_SCALING_MODE, MSG_SET_SKIP_SILENCE_ENABLED, MSG_SET_SURFACE, MSG_SET_VIDEO_DECODER_OUTPUT_BUFFER_RENDERER, MSG_SET_VIDEO_FRAME_METADATA_LISTENER, MSG_SET_VOLUME, MSG_SET_WAKEUP_LISTENER, STATE_DISABLED, STATE_ENABLED, STATE_STARTED, VIDEO_SCALING_MODE_DEFAULT, VIDEO_SCALING_MODE_SCALE_TO_FIT, VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING
- Fields inherited from interface com.google.android.exoplayer2.RendererCapabilities
  ADAPTIVE_NOT_SEAMLESS, ADAPTIVE_NOT_SUPPORTED, ADAPTIVE_SEAMLESS, ADAPTIVE_SUPPORT_MASK, FORMAT_EXCEEDS_CAPABILITIES, FORMAT_HANDLED, FORMAT_SUPPORT_MASK, FORMAT_UNSUPPORTED_DRM, FORMAT_UNSUPPORTED_SUBTYPE, FORMAT_UNSUPPORTED_TYPE, TUNNELING_NOT_SUPPORTED, TUNNELING_SUPPORT_MASK, TUNNELING_SUPPORTED

Constructor Summary

Constructors
Constructor	Description
`DecoderAudioRenderer()`
`DecoderAudioRenderer(Handler eventHandler, AudioRendererEventListener eventListener, AudioCapabilities audioCapabilities, AudioProcessor... audioProcessors)`
`DecoderAudioRenderer(Handler eventHandler, AudioRendererEventListener eventListener, AudioProcessor... audioProcessors)`
`DecoderAudioRenderer(Handler eventHandler, AudioRendererEventListener eventListener, AudioSink audioSink)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected DecoderReuseEvaluation`	`canReuseDecoder(String decoderName, Format oldFormat, Format newFormat)`	Evaluates whether the existing decoder can be reused for a new `Format`.
`protected abstract T`	`createDecoder(Format format, ExoMediaCrypto mediaCrypto)`	Creates a decoder for the given format.
`void`	`experimentalSetEnableKeepAudioTrackOnSeek(boolean enableKeepAudioTrackOnSeek)`	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()`	If the renderer advances its own playback position then this method returns a corresponding `MediaClock`.
`protected abstract Format`	`getOutputFormat(T decoder)`	Returns the format of audio buffers output by the decoder.
`PlaybackParameters`	`getPlaybackParameters()`	Returns the active playback parameters.
`long`	`getPositionUs()`	Returns the current media position in microseconds.
`protected int`	`getSinkFormatSupport(Format format)`	Returns the level of support that the renderer's `AudioSink` provides for a given `Format`.
`void`	`handleMessage(int messageType, Object message)`	Handles a message delivered to the target.
`boolean`	`isEnded()`	Whether the renderer is ready for the `ExoPlayer` instance to transition to `Player.STATE_ENDED`.
`boolean`	`isReady()`	Whether the renderer is able to immediately render media from the current position.
`protected void`	`onDisabled()`	Called when the renderer is disabled.
`protected void`	`onEnabled(boolean joining, boolean mayRenderStartOfStream)`	Called when the renderer is enabled.
`protected void`	`onPositionDiscontinuity()`	See `AudioSink.Listener.onPositionDiscontinuity()`.
`protected void`	`onPositionReset(long positionUs, boolean joining)`	Called when the position is reset.
`protected void`	`onStarted()`	Called when the renderer is started.
`protected void`	`onStopped()`	Called when the renderer is stopped.
`void`	`render(long positionUs, long elapsedRealtimeUs)`	Incrementally renders the `SampleStream`.
`void`	`setPlaybackParameters(PlaybackParameters playbackParameters)`	Attempts to set the playback parameters.
`protected boolean`	`sinkSupportsFormat(Format format)`	Returns whether the renderer's `AudioSink` supports a given `Format`.
`int`	`supportsFormat(Format format)`	Returns the extent to which the `Renderer` supports a given format.
`protected abstract int`	`supportsFormatInternal(Format format)`	Returns the `C.FormatSupport` for the given `Format`.

Methods inherited from class com.google.android.exoplayer2.BaseRenderer
createRendererException, createRendererException, disable, enable, getCapabilities, getConfiguration, getFormatHolder, getIndex, getLastResetPositionUs, getReadingPositionUs, getState, getStream, getStreamFormats, getTrackType, hasReadStreamToEnd, isCurrentStreamFinal, isSourceReady, maybeThrowStreamError, onReset, onStreamChanged, readSource, replaceStream, reset, resetPosition, setCurrentStreamFinal, setIndex, 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()
```
  - DecoderAudioRenderer
```
public DecoderAudioRenderer(@Nullable
                            Handler eventHandler,
                            @Nullable
                            AudioRendererEventListener eventListener,
                            AudioProcessor... audioProcessors)
```
    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 eventHandler,
                            @Nullable
                            AudioRendererEventListener eventListener,
                            @Nullable
                            AudioCapabilities audioCapabilities,
                            AudioProcessor... audioProcessors)
```
    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. May be null if the default capabilities (no encoded audio passthrough support) should be assumed.
    
    audioProcessors - Optional AudioProcessors that will process audio before output.
  - DecoderAudioRenderer
```
public DecoderAudioRenderer(@Nullable
                            Handler eventHandler,
                            @Nullable
                            AudioRendererEventListener eventListener,
                            AudioSink audioSink)
```
    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)
```
    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 getMediaClock()
```
    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 Renderer
    
    Overrides:
    
    getMediaClock in class BaseRenderer
    
    Returns:
    
    The MediaClock tracking the playback position of the renderer, or null.
  - supportsFormat
```
@Capabilities
public final int supportsFormat(Format format)
```
    Description copied from interface: RendererCapabilities
    
    Returns the extent to which the Renderer supports a given format.
    
    Specified by:
    
    supportsFormat in interface RendererCapabilities
    
    Parameters:
    
    format - The format.
    
    Returns:
    
    The RendererCapabilities.Capabilities for this format.
  - supportsFormatInternal
```
@FormatSupport
protected abstract int supportsFormatInternal(Format format)
```
    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)
```
    Returns whether the renderer's AudioSink supports a given Format.
    
    See Also:
    
    AudioSink.supportsFormat(Format)
  - getSinkFormatSupport
```
@SinkFormatSupport
protected final int getSinkFormatSupport(Format format)
```
    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
```
    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 Renderer
    
    Parameters:
    
    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
protected void onPositionDiscontinuity()
```
    See AudioSink.Listener.onPositionDiscontinuity().
  - createDecoder
```
protected abstract T createDecoder(Format format,
                                   @Nullable
                                   ExoMediaCrypto mediaCrypto)
                            throws DecoderException
```
    Creates a decoder for the given format.
    
    Parameters:
    
    format - The format for which a decoder is required.
    
    mediaCrypto - The ExoMediaCrypto object required for decoding encrypted content. Maybe 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
```
protected abstract Format getOutputFormat(T decoder)
```
    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
```
protected DecoderReuseEvaluation canReuseDecoder(String decoderName,
                                                 Format oldFormat,
                                                 Format newFormat)
```
    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()
```
    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 Renderer
    
    Returns:
    
    Whether the renderer is ready for the player to transition to the ended state.
  - isReady
```
public boolean isReady()
```
    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 Renderer
    
    Returns:
    
    Whether the renderer is ready to render media.
  - getPositionUs
```
public long getPositionUs()
```
    Description copied from interface: MediaClock
    
    Returns the current media position in microseconds.
    
    Specified by:
    
    getPositionUs in interface MediaClock
  - setPlaybackParameters
```
public void setPlaybackParameters(PlaybackParameters playbackParameters)
```
    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 MediaClock
    
    Parameters:
    
    playbackParameters - The playback parameters to attempt to set.
  - getPlaybackParameters
```
public PlaybackParameters getPlaybackParameters()
```
    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
```
    Description copied from class: BaseRenderer
    
    Called when the renderer is enabled.
    The default implementation is a no-op.
    
    Overrides:
    
    onEnabled in class BaseRenderer
    
    Parameters:
    
    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
```
    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 BaseRenderer
    
    Parameters:
    
    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()
```
    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()
```
    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()
```
    Description copied from class: BaseRenderer
    
    Called when the renderer is disabled.
    The default implementation is a no-op.
    
    Overrides:
    
    onDisabled in class BaseRenderer
  - handleMessage
```
public void handleMessage(int messageType,
                          @Nullable
                          Object message)
                   throws ExoPlaybackException
```
    Description copied from interface: PlayerMessage.Target
    
    Handles a message delivered to the target.
    
    Specified by:
    
    handleMessage in interface PlayerMessage.Target
    
    Overrides:
    
    handleMessage in class BaseRenderer
    
    Parameters:
    
    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.

Class DecoderAudioRenderer<T extends Decoder<DecoderInputBuffer,? extends SimpleOutputBuffer,? extends DecoderException>>

Nested Class Summary

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

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

Field Summary

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

DecoderAudioRenderer

DecoderAudioRenderer

DecoderAudioRenderer

DecoderAudioRenderer

Method Detail

experimentalSetEnableKeepAudioTrackOnSeek

getMediaClock

supportsFormat

supportsFormatInternal

sinkSupportsFormat

getSinkFormatSupport

render

onPositionDiscontinuity

createDecoder

getOutputFormat

canReuseDecoder

isEnded

isReady

getPositionUs

setPlaybackParameters

getPlaybackParameters

onEnabled

onPositionReset

onStarted

onStopped

onDisabled

handleMessage