FakeAudioRenderer

@UnstableApi
class FakeAudioRenderer : FakeRenderer

kotlin.Any
   ↳ androidx.media3.exoplayer.BaseRenderer
     ↳ androidx.media3.test.utils.FakeRenderer
       ↳ androidx.media3.test.utils.FakeAudioRenderer

A FakeRenderer that supports TRACK_TYPE_AUDIO.

Summary

Public constructors
FakeAudioRenderer(
    handler: HandlerWrapper!,
    eventListener: AudioRendererEventListener!
)

Protected functions
Unit

Called when the renderer is disabled.
Unit
onEnabled(joining: Boolean, mayRenderStartOfStream: Boolean)

Called when the renderer is enabled.
Unit

Called when the renderer reads a new format.
Boolean
shouldProcessBuffer(bufferTimeUs: Long, playbackPositionUs: Long)

Called before the renderer processes a buffer.

Inherited Constants
From androidx.media3.exoplayer.Renderer
const Int

Applications or extensions may define custom MSG_* constants that can be passed to renderers.
const Int

A type of a message that can be passed to an audio renderer via createMessage.
const Int

The type of a message that can be passed to audio and video renderers via createMessage.
const Int

A type of a message that can be passed to an audio renderer via createMessage.
const Int

The type of a message that can be passed to a camera motion renderer via createMessage.
const Int

The type of a message that can be passed to a video renderer via createMessage.
const Int

The type of message that can be passed to an image renderer to set a desired image output.
const Int

The type of a message that can be passed to audio renderers via createMessage.
const Int

The type of a message that can be passed to a MediaCodec-based video renderer via createMessage.
const Int

The type of a message that can be passed to an audio renderer via createMessage.
const Int

The type of a message that can be passed to a video renderer.
const Int

The type of a message that can be passed to a video renderer via createMessage.
const Int

The type of a message that can be passed to a video renderer via createMessage.
const Int

The type of a message that can be passed to a video renderer to set the desired output resolution.
const Int

A type of a message that can be passed to an audio renderer via createMessage.
const Int

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

The renderer is disabled.
const Int

The renderer is enabled but not started.
const Int

The renderer is started.
From androidx.media3.exoplayer.RendererCapabilities
const Int

The Renderer can adapt between formats, but may suffer a brief discontinuity (~50-100ms) when adaptation occurs.
const Int

The Renderer does not support adaptation between formats.
const Int

The Renderer can seamlessly adapt between formats.
const Int

A mask to apply to Capabilities to obtain the AdaptiveSupport only.
const Int

The renderer supports audio offload and gapless transitions with this format.
const Int

Audio offload is not supported with this format.
const Int

The renderer supports audio offload and speed changes with this format.
const Int

The renderer supports audio offload with this format.
const Int

A mask to apply to Capabilities to obtain AudioOffloadSupport only.
const Int

The format exceeds the primary decoder's capabilities but is supported by fallback decoder
const Int

The format's MIME type is unsupported and the renderer may use a decoder for a fallback MIME type.
const Int

A mask to apply to Capabilities to obtain DecoderSupport only.
const Int

The renderer is able to use the primary decoder for the format's MIME type.
const Int

This property is deprecated.

Use FORMAT_EXCEEDS_CAPABILITIES instead.
const Int

This property is deprecated.

Use FORMAT_HANDLED instead.
const Int

A mask to apply to Capabilities to obtain the C.FormatSupport only.
const Int

This property is deprecated.

Use FORMAT_UNSUPPORTED_DRM instead.
const Int

This property is deprecated.

Use FORMAT_UNSUPPORTED_SUBTYPE instead.
const Int

This property is deprecated.

Use FORMAT_UNSUPPORTED_TYPE instead.
const Int

The renderer is not able to use hardware acceleration.
const Int

The renderer is able to use hardware acceleration.
const Int

A mask to apply to Capabilities to obtain HardwareAccelerationSupport only.
const Int

The Renderer does not support tunneled output.
const Int

The Renderer supports tunneled output.
const Int

A mask to apply to Capabilities to obtain TunnelingSupport only.

Inherited functions
From androidx.media3.exoplayer.BaseRenderer
Unit

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 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!

Returns the capabilities of the renderer.
MediaClock?

If the renderer advances its own playback position then this method returns a corresponding MediaClock.
Unit
handleMessage(@Renderer.MessageType messageType: Int, message: Any?)

Handles a message delivered to the target.
Boolean

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

Returns whether the current SampleStream will be the final one supplied before the renderer is next disabled or reset.
Boolean

Returns whether the upstream source is ready.
Unit

Throws an error that's preventing the renderer from reading from its SampleStream.
Unit

Called when the renderer is initialized.
Unit

Called when the renderer is released.
Unit

Called when the renderer capabilities are changed.
Unit

Called when the renderer is started.
Unit

Called when the renderer is stopped.
Unit
onStreamChanged(
    formats: Array<Format!>!,
    startPositionUs: Long,
    offsetUs: Long,
    mediaPeriodId: MediaSource.MediaPeriodId!
)

Called when the renderer's stream has changed.
Unit

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

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

Forces the renderer to give up any resources (e.g. media decoders) that it may be holding.
Unit
resetPosition(positionUs: Long)

Signals to the renderer that a position discontinuity has occurred.
Unit

Signals to the renderer that the current SampleStream will be the final one supplied before it is next disabled or reset.
Unit

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

Starts the renderer, meaning that calls to render will cause media to be rendered.
Unit

Stops the renderer, transitioning it to the STATE_ENABLED state.
Int

Returns the extent to which the Renderer supports adapting between supported formats that have different MIME types.
From androidx.media3.test.utils.FakeRenderer
String!

Returns the name of this renderer, for logging and debugging purposes.
Boolean

Whether the renderer is ready for the ExoPlayer instance to transition to STATE_ENDED.
Boolean

Whether the renderer is able to immediately render media from the current position.
Unit
onPositionReset(positionUs: Long, joining: Boolean)

Called when the position is reset.
Unit

Called when the renderer is reset.
Unit
render(positionUs: Long, elapsedRealtimeUs: Long)

Incrementally renders the SampleStream.
Int

Returns the extent to which the Renderer supports a given format.
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

Enables this renderer to render the start of the stream even if the state is not STATE_STARTED yet.
abstract Unit
replaceStream(
    formats: Array<Format!>!,
    stream: SampleStream!,
    startPositionUs: Long,
    offsetUs: Long,
    mediaPeriodId: MediaSource.MediaPeriodId!
)

Replaces the SampleStream from which samples will be consumed.
Unit
setPlaybackSpeed(currentPlaybackSpeed: Float, targetPlaybackSpeed: Float)

Indicates the playback speed to this renderer.
From androidx.media3.exoplayer.RendererCapabilities
java-static Int

Returns Capabilities for the given C.FormatSupport.
java-static Int

Returns Capabilities combining the given C.FormatSupport, and TunnelingSupport.
java-static Int
@RendererCapabilities.Capabilities
create(
    @C.FormatSupport formatSupport: Int,
    @RendererCapabilities.AdaptiveSupport adaptiveSupport: Int,
    @RendererCapabilities.TunnelingSupport tunnelingSupport: Int,
    @RendererCapabilities.AudioOffloadSupport audioOffloadSupport: Int
)

Returns Capabilities combining the given C.FormatSupport, , TunnelingSupport, and AudioOffloadSupport.
java-static Int
@RendererCapabilities.Capabilities
create(
    @C.FormatSupport formatSupport: Int,
    @RendererCapabilities.AdaptiveSupport adaptiveSupport: Int,
    @RendererCapabilities.TunnelingSupport tunnelingSupport: Int,
    @RendererCapabilities.HardwareAccelerationSupport hardwareAccelerationSupport: Int,
    @RendererCapabilities.DecoderSupport decoderSupport: Int
)

Returns Capabilities combining the given C.FormatSupport, , TunnelingSupport, HardwareAccelerationSupport, and .
java-static Int
@RendererCapabilities.Capabilities
create(
    @C.FormatSupport formatSupport: Int,
    @RendererCapabilities.AdaptiveSupport adaptiveSupport: Int,
    @RendererCapabilities.TunnelingSupport tunnelingSupport: Int,
    @RendererCapabilities.HardwareAccelerationSupport hardwareAccelerationSupport: Int,
    @RendererCapabilities.DecoderSupport decoderSupport: Int,
    @RendererCapabilities.AudioOffloadSupport audioOffloadSupport: Int
)

Returns Capabilities combining the given C.FormatSupport, , TunnelingSupport, HardwareAccelerationSupport, and AudioOffloadSupport.
java-static Int

Returns the AdaptiveSupport from the combined Capabilities.
java-static Int

Returns the AudioOffloadSupport from the combined Capabilities.
java-static Int

Returns the DecoderSupport from the combined Capabilities.
java-static Int

Returns the C.FormatSupport from the combined Capabilities.
java-static Int

Returns the HardwareAccelerationSupport from the combined Capabilities.
java-static Int

Returns the TunnelingSupport from the combined Capabilities.
Unit

Sets the Listener.

Inherited properties
From androidx.media3.exoplayer.BaseRenderer
@MonotonicNonNull Clock!
RendererConfiguration?
FormatHolder!
Int
Long
@MonotonicNonNull PlayerId!
Long
Int
SampleStream?
Array<Format!>?
Timeline!
Int
From androidx.media3.test.utils.FakeRenderer
Int
(Mutable)List<Format!>!
Boolean
Int
Int
Int

Public constructors

FakeAudioRenderer

FakeAudioRenderer(
    handler: HandlerWrapper!,
    eventListener: AudioRendererEventListener!
)

Protected functions

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.

onFormatChanged

protected fun onFormatChanged(format: Format!): Unit

Called when the renderer reads a new format.

shouldProcessBuffer

protected fun shouldProcessBuffer(bufferTimeUs: Long, playbackPositionUs: Long): Boolean

Called before the renderer processes a buffer.

Parameters
bufferTimeUs: Long

The buffer timestamp, in microseconds.
playbackPositionUs: Long

The playback position, in microseconds
Returns
Boolean

Whether the buffer should be processed.