TrimmingAudioProcessor

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
public final class TrimmingAudioProcessor extends BaseAudioProcessor

java.lang.Object
↳	androidx.media3.common.audio.BaseAudioProcessor
	↳	androidx.media3.exoplayer.audio.TrimmingAudioProcessor

Audio processor for trimming samples from the start/end of data.

Summary

Public fields
`long`	`trimmedFrameCount`

Public constructors
`TrimmingAudioProcessor()` Creates a new audio processor for trimming samples from the start/end of data.

Public methods
`long`	`getDurationAfterProcessorApplied(long durationUs)` Returns the expected duration of the output stream when the processor is applied given a input `durationUs`.
`ByteBuffer`	`getOutput()` Returns a buffer containing processed output data between its position and limit.
`long`	`getTrimmedFrameCount()` Returns the number of audio frames trimmed since the last call to `resetTrimmedFrameCount`.
`boolean`	`isEnded()` Returns whether this processor will return no more output from `getOutput` until `flush` has been called and more input has been queued.
`AudioProcessor.AudioFormat`	`onConfigure(AudioProcessor.AudioFormat inputAudioFormat)` Called when the processor is configured for a new input format.
`void`	`queueInput(ByteBuffer inputBuffer)` Queues audio data between the position and limit of the `inputBuffer` for processing.
`void`	`resetTrimmedFrameCount()` Sets the trimmed frame count returned by `getTrimmedFrameCount` to zero.
`void`	`setTrimFrameCount(int trimStartFrames, int trimEndFrames)` Sets the number of audio frames to trim from the start and end of audio passed to this processor.

Protected methods
`void`	`onFlush()` Called when the processor is flushed, directly or as part of resetting.
`void`	`onQueueEndOfStream()` Called when the end-of-stream is queued to the processor.
`void`	`onReset()` Called when the processor is reset.

Inherited Constants

From androidx.media3.common.audio.AudioProcessor

static final ByteBuffer

EMPTY_BUFFER

An empty, direct ByteBuffer.

Inherited fields

From androidx.media3.common.audio.BaseAudioProcessor

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

Inherited methods

From androidx.media3.common.audio.BaseAudioProcessor

`final AudioProcessor.AudioFormat`	`configure(AudioProcessor.AudioFormat inputAudioFormat)` Configures the processor to process input audio with the specified format.
`final void`	`flush()` Clears any buffered data and pending output.
`final 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.
`final void`	`queueEndOfStream()` Queues an end of stream signal.
`final ByteBuffer`	`replaceOutputBuffer(int size)` Replaces the current output buffer with a buffer of at least `size` bytes and returns it.
`final void`	`reset()` Resets the processor to its unconfigured state, releasing any resources.

Public fields

trimmedFrameCount

public long trimmedFrameCount

Public constructors

TrimmingAudioProcessor

public TrimmingAudioProcessor()

Creates a new audio processor for trimming samples from the start/end of data.

Public methods

getDurationAfterProcessorApplied

public long getDurationAfterProcessorApplied(long durationUs)

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

getOutput

public ByteBuffer getOutput()

Returns a buffer containing processed output data between its position and limit. The buffer will always be a direct byte buffer with native byte order. Calling this method invalidates any previously returned buffer. The buffer will be empty if no output is available.

Returns
`ByteBuffer`	A buffer containing processed output data between its position and limit.

getTrimmedFrameCount

public long getTrimmedFrameCount()

Returns the number of audio frames trimmed since the last call to resetTrimmedFrameCount.

isEnded

public boolean isEnded()

Returns whether this processor will return no more output from getOutput until flush has been called and more input has been queued.

onConfigure

public AudioProcessor.AudioFormat onConfigure(AudioProcessor.AudioFormat inputAudioFormat)

Called when the processor is configured for a new input format.

Throws
`androidx.media3.common.audio.AudioProcessor.UnhandledAudioFormatException`

queueInput

public void queueInput(ByteBuffer inputBuffer)

Queues audio data between the position and limit of the inputBuffer for processing. After calling this method, processed output may be available via getOutput. Calling queueInput(ByteBuffer) again invalidates any pending output.

Parameters
`ByteBuffer inputBuffer`	The input buffer to process. It must be a direct byte buffer with native byte order. Its contents are treated as read-only. Its position will be advanced by the number of bytes consumed (which may be zero). The caller retains ownership of the provided buffer.

resetTrimmedFrameCount

public void resetTrimmedFrameCount()

Sets the trimmed frame count returned by getTrimmedFrameCount to zero.

setTrimFrameCount

public void setTrimFrameCount(int trimStartFrames, int trimEndFrames)

Sets the number of audio frames to trim from the start and end of audio passed to this processor. After calling this method, call configure to apply the new trimming frame counts.

See configure.

Parameters
`int trimStartFrames`	The number of audio frames to trim from the start of audio.
`int trimEndFrames`	The number of audio frames to trim from the end of audio.

Protected methods

onFlush

protected void onFlush()

Called when the processor is flushed, directly or as part of resetting.

onQueueEndOfStream

protected void onQueueEndOfStream()

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

onReset

protected void onReset()

Called when the processor is reset.