SpeedChangingAudioProcessor

@UnstableApi
class SpeedChangingAudioProcessor : AudioProcessor

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

Summary

Public constructors

Public functions
AudioProcessor.AudioFormat!

Configures the processor to process input audio with the specified format.
Unit

Clears any buffered data and pending output.
Long

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

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

Returns a buffer containing processed output data between its position and limit.
java-static Long
getSampleCountAfterProcessorApplied(
    speedProvider: SpeedProvider!,
    inputSampleRateHz: @IntRange(from = 1) Int,
    inputSamples: @IntRange(from = 1) Long
)

Returns the estimated number of samples output given the provided parameters.
Unit
getSpeedAdjustedTimeAsync(inputTimeUs: Long, callback: TimestampConsumer!)

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

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

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

Queues an end of stream signal.
Unit
queueInput(inputBuffer: ByteBuffer!)

Queues audio data between the position and limit of the inputBuffer for processing.
Unit

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

Inherited Constants
From androidx.media3.common.audio.AudioProcessor
const ByteBuffer!

An empty, direct ByteBuffer.

Public constructors

SpeedChangingAudioProcessor

SpeedChangingAudioProcessor(speedProvider: SpeedProvider!)

Public functions

configure

fun configure(inputAudioFormat: AudioProcessor.AudioFormat!): AudioProcessor.AudioFormat!

Configures the processor to process input audio with the specified format. After calling this method, call isActive to determine whether the audio processor is active. Returns the configured output audio format if this instance is active.

After calling this method, it is necessary to flush the processor to apply the new configuration. Before applying the new configuration, it is safe to queue input and get output in the old input/output formats. Call queueEndOfStream when no more input will be supplied in the old input format.

Parameters
inputAudioFormat: AudioProcessor.AudioFormat!

The format of audio that will be queued after the next call to flush.
Returns
AudioProcessor.AudioFormat!

The configured output audio format if this instance is active.
Throws
androidx.media3.common.audio.AudioProcessor.UnhandledAudioFormatException

Thrown if the specified format can't be handled as input.

flush

fun flush(): Unit

Clears any buffered data and pending output. If the audio processor is active, also prepares the audio processor to receive a new stream of input in the last configured (pending) format.

getDurationAfterProcessorApplied

fun getDurationAfterProcessorApplied(durationUs: Long): Long

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

getMediaDurationUs

fun getMediaDurationUs(playoutDurationUs: Long): Long

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
playoutDurationUs: Long

The playout duration in microseconds.
Returns
Long

The corresponding input duration in microseconds.

getOutput

fun getOutput(): ByteBuffer!

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.

getSampleCountAfterProcessorApplied

java-static fun getSampleCountAfterProcessorApplied(
    speedProvider: SpeedProvider!,
    inputSampleRateHz: @IntRange(from = 1) Int,
    inputSamples: @IntRange(from = 1) Long
): Long

Returns the estimated number of samples output given the provided parameters.

getSpeedAdjustedTimeAsync

fun getSpeedAdjustedTimeAsync(inputTimeUs: Long, callback: TimestampConsumer!): Unit

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
inputTimeUs: Long

The input time, in microseconds.
callback: TimestampConsumer!

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

isActive

fun isActive(): Boolean

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

isEnded

fun isEnded(): Boolean

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

queueEndOfStream

fun queueEndOfStream(): Unit

Queues an end of stream signal. After this method has been called, queueInput may not be called until after the next call to flush. Calling getOutput will return any remaining output data. Multiple calls may be required to read all of the remaining output data. isEnded will return true once all remaining output data has been read.

queueInput

fun queueInput(inputBuffer: ByteBuffer!): Unit

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
inputBuffer: ByteBuffer!

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.

reset

fun reset(): Unit

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