TeeAudioProcessor

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
class TeeAudioProcessor : BaseAudioProcessor

kotlin.Any
↳	androidx.media3.common.audio.BaseAudioProcessor
	↳	androidx.media3.exoplayer.audio.TeeAudioProcessor

Audio processor that outputs its input unmodified and also outputs its input to a given sink. This is intended to be used for diagnostics and debugging.

This audio processor can be inserted into the audio processor chain to access audio data before/after particular processing steps have been applied. For example, to get audio output after playback speed adjustment and silence skipping have been applied it is necessary to pass a custom AudioProcessorChain when creating the audio sink, and include this audio processor after all other audio processors.

Summary

Nested types
`interface TeeAudioProcessor.AudioBufferSink` A sink for audio buffers handled by the audio processor.
`class TeeAudioProcessor.WavFileAudioBufferSink : TeeAudioProcessor.AudioBufferSink` A sink for audio buffers that writes output audio as .wav files with a given path prefix.

Public constructors
`TeeAudioProcessor(audioBufferSink: TeeAudioProcessor.AudioBufferSink!)` Creates a new tee audio processor, sending incoming data to the given `AudioBufferSink`.

Public functions
`AudioProcessor.AudioFormat!`	`onConfigure(inputAudioFormat: AudioProcessor.AudioFormat!)` Called when the processor is configured for a new input format.
`Unit`	`queueInput(inputBuffer: ByteBuffer!)` Queues audio data between the position and limit of the `inputBuffer` for processing.

Protected functions
`Unit`	`onFlush()` This function is deprecated. Use `onFlush` instead.
`Unit`	`onQueueEndOfStream()` Called when the end-of-stream is queued to the processor.
`Unit`	`onReset()` Called when the processor is reset.

Protected functions

Unit

onFlush()

This function is deprecated.

Use onFlush instead.

Unit

onQueueEndOfStream()

Called when the end-of-stream is queued to the processor.

Unit

onReset()

Called when the processor is reset.

Inherited Constants

From androidx.media3.common.audio.AudioProcessor

const ByteBuffer!

EMPTY_BUFFER

An empty, direct ByteBuffer.

Inherited functions

From androidx.media3.common.audio.AudioProcessor

Long

getDurationAfterProcessorApplied(durationUs: Long)

Returns the expected duration of the output stream when the processor is applied given a input durationUs.

From androidx.media3.common.audio.BaseAudioProcessor

`AudioProcessor.AudioFormat!`	`configure(inputAudioFormat: AudioProcessor.AudioFormat!)` Configures the processor to process input audio with the specified format.
`Unit`	`flush()` This function is deprecated. Use `flush` instead.
`Unit`	`flush(streamMetadata: AudioProcessor.StreamMetadata!)` Prepares the audio processor to receive a new stream of input in the last `configured format` and clears any buffered data and pending output.
`ByteBuffer!`	`@CallSuper getOutput()` Returns a buffer containing processed output data between its position and limit.
`Boolean`	`hasPendingOutput()` Returns whether the current output buffer has any data remaining.
`Boolean`	`@CallSuper isActive()` Returns whether the processor is configured and will process input buffers.
`Boolean`	`@CallSuper isEnded()` Returns whether this processor will return no more output from `getOutput` until `flush` has been called and more input has been queued.
`Unit`	`onFlush(streamMetadata: AudioProcessor.StreamMetadata!)` Called when the processor is `flushed`.
`Unit`	`queueEndOfStream()` Queues an end of stream signal.
`ByteBuffer!`	`replaceOutputBuffer(size: Int)` Replaces the current output buffer with a buffer of at least `size` bytes and returns it.
`Unit`	`reset()` Resets the processor to its unconfigured state, releasing any resources.

Inherited properties

From androidx.media3.common.audio.BaseAudioProcessor

`AudioProcessor.AudioFormat!`	`inputAudioFormat` The current input audio format.
`AudioProcessor.AudioFormat!`	`outputAudioFormat` The current output audio format.

Public constructors