FakeAudioRenderer

Artifact: androidx.media3:media3-test-utils

Kotlin |Java

@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`	`onDisabled()` Called when the renderer is disabled.
`Unit`	`onEnabled(joining: Boolean, mayRenderStartOfStream: Boolean)` Called when the renderer is enabled.
`Unit`	`onFormatChanged(format: Format!)` 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 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_CODEC_PARAMETERS = 21` The type of a message that can be passed to renderers via `createMessage`.
`const Int`	`MSG_SET_IMAGE_METADATA_LISTENER = 23` The type of a message that can be passed to an image 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_SUBSCRIBED_CODEC_PARAMETER_KEYS = 22` A message to set the keys for which a renderer should report parameter changes.
`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.
`MediaClock?`	`getMediaClock()` 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`	`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`	`onRendererCapabilitiesChanged()` Called when the renderer capabilities are changed.
`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.
`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.test.utils.FakeRenderer

`String!`	`getName()` Returns the name of this renderer, for logging and debugging purposes.
`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`	`onInit()` Called when the renderer is initialized.
`Unit`	`onPositionReset( positionUs: Long, joining: Boolean, sampleStreamIsResetToKeyFrame: Boolean )` Called when the position is reset.
`Unit`	`onRelease()` Called when the renderer is released.
`Unit`	`onReset()` Called when the renderer is reset.
`Unit`	`render(positionUs: Long, elapsedRealtimeUs: Long)` Incrementally renders the `SampleStream`.
`Int`	`@RendererCapabilities.Capabilities supportsFormat(format: Format!)` 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`	`enableMayRenderStartOfStream()` Enables this renderer to render the start of the stream even if the state is not `STATE_STARTED` yet.
`Long`	`getDurationToProgressUs(positionUs: Long, elapsedRealtimeUs: Long)` Returns minimum amount of playback clock time that must pass from `elapsedRealtimeUs` in order for the `render` call to make progress.
`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`
`Long`	`streamEndPositionUs`
`Array<Format!>?`	`streamFormats`
`Long`	`streamOffsetUs`
`Timeline!`	`timeline`
`Int`	`@C.TrackType trackType`

From androidx.media3.test.utils.FakeRenderer

`Int`	`enabledCount`
`(Mutable)List<Format!>!`	`formatsRead`
`Boolean`	`isEnded`
`Boolean`	`isInitialized`
`Boolean`	`isReleased`
`Int`	`positionResetCount`
`Int`	`resetCount`
`Int`	`sampleBufferReadCount`

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.