# SpeedChangingAudioProcessor

Artifact: [androidx.media3:media3-common](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/common/audio/SpeedChangingAudioProcessor.java+class:androidx.media3.common.audio.SpeedChangingAudioProcessor)

*** ** * ** ***


```
@UnstableApi
public final class SpeedChangingAudioProcessor implements AudioProcessor
```

<br />

*** ** * ** ***

An `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor` that changes the speed of audio samples depending on their timestamp.

## Summary

| ### Public fields |
|---|---|
| `final https://developer.android.com/reference/androidx/media3/common/audio/SpeedProvider` | `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#speedProvider()` The speed provider that provides the speed for each timestamp. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#SpeedChangingAudioProcessor(androidx.media3.common.audio.SpeedProvider)(https://developer.android.com/reference/androidx/media3/common/audio/SpeedProvider speedProvider)` Creates a new instance. |

| ### Public methods |
|---|---|
| `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor.AudioFormat` | `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#configure(androidx.media3.common.audio.AudioProcessor.AudioFormat)(https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor.AudioFormat inputAudioFormat)` Configures the processor to process input audio with the specified format. |
| `void` | `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#flush(androidx.media3.common.audio.AudioProcessor.StreamMetadata)(https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor.StreamMetadata streamMetadata)` Prepares the audio processor to receive a new stream of input in the last `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#configure(androidx.media3.common.audio.AudioProcessor.AudioFormat)` and clears any buffered data and pending output. |
| `long` | `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#getDurationAfterProcessorApplied(long)(long durationUs)` Returns the expected duration of the output stream when the processor is applied given a input `durationUs`. |
| `long` | `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#getMediaDurationUs(long)(long playoutDurationUs)` Returns the input media duration in microseconds for the given playout duration. |
| `https://developer.android.com/reference/java/nio/ByteBuffer.html` | `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#getOutput()()` Returns a buffer containing processed output data between its position and limit. |
| `static long` | `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#getSampleCountAfterProcessorApplied(androidx.media3.common.audio.SpeedProvider,int,long)( https://developer.android.com/reference/androidx/media3/common/audio/SpeedProvider speedProvider, @https://developer.android.com/reference/androidx/annotation/IntRange(from = 1) int inputSampleRateHz, @https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) long inputSamples )` Returns the estimated number of samples output given the provided parameters. |
| `void` | `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#getSpeedAdjustedTimeAsync(long,androidx.media3.common.util.TimestampConsumer)(long inputTimeUs, https://developer.android.com/reference/androidx/media3/common/util/TimestampConsumer callback)` Calculates the time at which the `inputTimeUs` is outputted at after the speed changes has been applied. |
| `https://developer.android.com/reference/androidx/media3/common/audio/SpeedProvider` | `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#getSpeedProvider()()` Returns the `https://developer.android.com/reference/androidx/media3/common/audio/SpeedProvider` set for this instance. |
| `boolean` | `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#isActive()()` Returns whether the processor is configured and will process input buffers. |
| `boolean` | `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#isEnded()()` Returns whether this processor will return no more output from `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#getOutput()` until `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#flush()` has been called and more input has been queued. |
| `void` | `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#queueEndOfStream()()` Queues an end of stream signal. |
| `void` | `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#queueInput(java.nio.ByteBuffer)(https://developer.android.com/reference/java/nio/ByteBuffer.html inputBuffer)` Queues audio data between the position and limit of the `inputBuffer` for processing. |
| `void` | `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#reset()()` Resets the processor to its unconfigured state, releasing any resources. |

| ### Inherited Constants |
|---|
| From [androidx.media3.common.audio.AudioProcessor](https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor) |---|---| | `static final https://developer.android.com/reference/java/nio/ByteBuffer.html` | `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#EMPTY_BUFFER()` An empty, direct `https://developer.android.com/reference/java/nio/ByteBuffer.html`. | |

| ### Inherited methods |
|---|
| From [androidx.media3.common.audio.AudioProcessor](https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor) |---|---| | `void` | `[flush](https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#flush())()` **This method is deprecated.** Use `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#flush(androidx.media3.common.audio.AudioProcessor.StreamMetadata)` instead. <br /> | |

## Public fields

### speedProvider

```
public final SpeedProvider speedProvider
```

The speed provider that provides the speed for each timestamp.

## Public constructors

### SpeedChangingAudioProcessor

```
public SpeedChangingAudioProcessor(SpeedProvider speedProvider)
```

Creates a new instance.

## Public methods

### configure

```
public AudioProcessor.AudioFormat configure(AudioProcessor.AudioFormat inputAudioFormat)
```

Configures the processor to process input audio with the specified format. After calling this method, call `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#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 `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#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 `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#queueEndOfStream()` when no more input will be supplied in the old input format.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor.AudioFormat inputAudioFormat` | The format of audio that will be queued after the next call to `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#flush()`. |

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor.AudioFormat` | The configured output audio format if this instance is `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#isActive()`. |

| Throws |
|---|---|
| `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor.UnhandledAudioFormatException` | Thrown if the specified format can't be handled as input. |

### flush

```
public void flush(AudioProcessor.StreamMetadata streamMetadata)
```

Prepares the audio processor to receive a new stream of input in the last `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#configure(androidx.media3.common.audio.AudioProcessor.AudioFormat)` and clears any buffered data and pending output.

This method is a no-op if the processor is not `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#isActive()`.

### getDurationAfterProcessorApplied

```
public long getDurationAfterProcessorApplied(long durationUs)
```

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

This method assumes `durationUs` of input is applied from the beginning of the stream (i.e. after a `flush(StreamMetadata.DEFAULT)` call).

### getMediaDurationUs

```
public long getMediaDurationUs(long playoutDurationUs)
```

Returns the input media duration in microseconds for the given playout duration.

This method returns the inverse of `https://developer.android.com/reference/androidx/media3/common/audio/SpeedChangingAudioProcessor#getSpeedAdjustedTimeAsync(long,androidx.media3.common.util.TimestampConsumer)` when the instance has been configured and flushed. Otherwise, it returns `playoutDurationUs`.

| Parameters |
|---|---|
| `long playoutDurationUs` | The playout 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 |
|---|---|
| `https://developer.android.com/reference/java/nio/ByteBuffer.html` | A buffer containing processed output data between its position and limit. |

### getSampleCountAfterProcessorApplied

```
public static long getSampleCountAfterProcessorApplied(
    SpeedProvider speedProvider,
    @IntRange(from = 1) int inputSampleRateHz,
    @IntRange(from = 0) long inputSamples
)
```

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

### 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 `https://developer.android.com/reference/java/util/function/LongConsumer.html#accept(long)` 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. |
| `https://developer.android.com/reference/androidx/media3/common/util/TimestampConsumer callback` | The callback called with the output time. May be called on a different thread from the caller of this method. |

### getSpeedProvider

```
public SpeedProvider getSpeedProvider()
```

Returns the `https://developer.android.com/reference/androidx/media3/common/audio/SpeedProvider` set for this instance.

### isActive

```
public boolean isActive()
```

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

### isEnded

```
public boolean isEnded()
```

Returns whether this processor will return no more output from `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#getOutput()` until `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#flush()` has been called and more input has been queued.

### queueEndOfStream

```
public void queueEndOfStream()
```

Queues an end of stream signal. After this method has been called, `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#queueInput(java.nio.ByteBuffer)` may not be called until after the next call to `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#flush()`. Calling `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#getOutput()` will return any remaining output data. Multiple calls may be required to read all of the remaining output data. `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#isEnded()` will return `true` once all remaining output data has been read.

### 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 `https://developer.android.com/reference/androidx/media3/common/audio/AudioProcessor#getOutput()`. Calling `queueInput(ByteBuffer)` again invalidates any pending output.

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/nio/ByteBuffer.html 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. |

### reset

```
public void reset()
```

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