SpeedChangingAudioProcessor

@UnstableApi
public final class SpeedChangingAudioProcessor extends BaseAudioProcessor

java.lang.Object
   ↳ androidx.media3.common.audio.BaseAudioProcessor
     ↳ androidx.media3.common.audio.SpeedChangingAudioProcessor

An AudioProcessor that changes the speed of audio samples depending on their timestamp.

Summary

Public constructors

Public methods
long

Returns the expected duration of the output stream when the processor is applied given a input durationUs.
long
getMediaDurationUs(long playoutDurationUs)

Returns the input media duration for the given playout duration.
ByteBuffer

Returns a buffer containing processed output data between its position and limit.
void
getSpeedAdjustedTimeAsync(long inputTimeUs, TimestampConsumer callback)

Calculates the time at which the inputTimeUs is outputted at after the speed changes has been applied.
boolean

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

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.

Protected methods
void

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

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

Called when the processor is reset.

Inherited Constants
From androidx.media3.common.audio.AudioProcessor
static final ByteBuffer

An empty, direct ByteBuffer.

Inherited fields
From androidx.media3.common.audio.BaseAudioProcessor
AudioProcessor.AudioFormat

The current input audio format.
AudioProcessor.AudioFormat

The current output audio format.

Inherited methods
From androidx.media3.common.audio.BaseAudioProcessor
final AudioProcessor.AudioFormat

Configures the processor to process input audio with the specified format.
final void

Clears any buffered data and pending output.
final boolean

Returns whether the current output buffer has any data remaining.
boolean

Returns whether the processor is configured and will process input buffers.
final void

Queues an end of stream signal.
final ByteBuffer

Replaces the current output buffer with a buffer of at least size bytes and returns it.
final void

Resets the processor to its unconfigured state, releasing any resources.

Public constructors

SpeedChangingAudioProcessor

public SpeedChangingAudioProcessor(SpeedProvider speedProvider)

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.

getMediaDurationUs

public long getMediaDurationUs(long playoutDurationUs)

Returns the input media duration for the given playout duration.

Both durations are counted from the last reset or flush of the audio processor.

The playoutDurationUs must be less than last processed buffer output time.

Parameters
long playoutDurationUs

The playout duration in microseconds.
Returns
long

The corresponding input duration in microseconds.

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.

getSpeedAdjustedTimeAsync

public void getSpeedAdjustedTimeAsync(long inputTimeUs, TimestampConsumer callback)

Calculates the time at which the inputTimeUs is outputted at after the speed changes has been applied.

Calls the callback with the output time as soon as enough audio has been processed to calculate it.

If the audio processor has ended, speeds will come out at the last processed speed of the audio processor.

Successive calls must have monotonically increasing inputTimeUs.

Can be called from any thread.

Parameters
long inputTimeUs

The input time, in microseconds.
TimestampConsumer callback

The callback called with the output time. May be called on a different thread from the caller of this method.

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.

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.