# SilenceSkippingAudioProcessor

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

*** ** * ** ***

<br />

```
@UnstableApi
class SilenceSkippingAudioProcessor : BaseAudioProcessor
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.media3.common.audio.BaseAudioProcessor](https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor) ||
|   | ↳ | [androidx.media3.exoplayer.audio.SilenceSkippingAudioProcessor](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor) |

*** ** * ** ***

An `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor` that skips silence in the input stream. Input and output are 16-bit PCM.

## Summary

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#DEFAULT_MAX_SILENCE_TO_KEEP_DURATION_US() = 2000000` Default maximum silence to keep in microseconds. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#DEFAULT_MINIMUM_SILENCE_DURATION_US() = 100000` Default minimum duration of audio that must be below `silenceThresholdLevel` before silence starts being trimmed. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#DEFAULT_MIN_VOLUME_TO_KEEP_PERCENTAGE() = 10` Default volume percentage to keep. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#DEFAULT_PADDING_SILENCE_US() = 20000` **This property is deprecated.** Specify silence behaviour via `silenceRetentionRatio` instead. <br /> |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#DEFAULT_SILENCE_RETENTION_RATIO() = 0.2f` Default fraction of the original silence to keep. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-short/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#DEFAULT_SILENCE_THRESHOLD_LEVEL() = 1024` Default absolute level below which an individual PCM sample is classified as silent. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#SilenceSkippingAudioProcessor()()` Creates a new silence skipping audio processor. |
| `[SilenceSkippingAudioProcessor](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#SilenceSkippingAudioProcessor(long,long,short))( minimumSilenceDurationUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, paddingSilenceUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, silenceThresholdLevel: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-short/index.html )` **This function is deprecated.** Use `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#SilenceSkippingAudioProcessor(long,float,long,int,short)` instead. <br /> |
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#SilenceSkippingAudioProcessor(long,float,long,int,short)( minimumSilenceDurationUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, silenceRetentionRatio: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, maxSilenceToKeepDurationUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, minVolumeToKeepPercentageWhenMuting: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, silenceThresholdLevel: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-short/index.html )` Creates a new silence trimming audio processor. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#isActive()()` Returns whether the processor is configured and will process input buffers. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#onFlush(androidx.media3.common.audio.AudioProcessor.StreamMetadata)(streamMetadata: https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor.StreamMetadata!)` Called when the processor is `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor#flush(androidx.media3.common.audio.AudioProcessor.StreamMetadata)`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#onQueueEndOfStream()()` Called when the end-of-stream is queued to the processor. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#onReset()()` Called when the processor is reset. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#queueInput(java.nio.ByteBuffer)(inputBuffer: https://developer.android.com/reference/java/nio/ByteBuffer.html!)` Queues audio data between the position and limit of the `inputBuffer` for processing. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#setEnabled(boolean)(enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` Sets whether to shorten silence in the input. |

| ### Protected functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor.AudioFormat!` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#onConfigure(androidx.media3.common.audio.AudioProcessor.AudioFormat)(inputAudioFormat: https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor.AudioFormat!)` Called when the processor is configured for a new input format. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#skippedFrames()` |

### Inherited Constants

From [androidx.media3.common.audio.AudioProcessor](https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor) `const https://developer.android.com/reference/java/nio/ByteBuffer.html!` `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor#EMPTY_BUFFER()`

An empty, direct `https://developer.android.com/reference/java/nio/ByteBuffer.html`.

### Inherited functions

From [androidx.media3.common.audio.AudioProcessor](https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor#getDurationAfterProcessorApplied(long)(durationUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)`

Returns the expected duration of the output stream when the processor is applied given a input `durationUs`.
From [androidx.media3.common.audio.BaseAudioProcessor](https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor) `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor.AudioFormat!` `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor#configure(androidx.media3.common.audio.AudioProcessor.AudioFormat)(inputAudioFormat: https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor.AudioFormat!)`

Configures the processor to process input audio with the specified format.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[flush](https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor#flush())()`

**This function is deprecated.**

Use `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor#flush(androidx.media3.common.audio.AudioProcessor.StreamMetadata)` instead.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor#flush(androidx.media3.common.audio.AudioProcessor.StreamMetadata)(streamMetadata: https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor.StreamMetadata!)`

Prepares the audio processor to receive a new stream of input in the last `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor#configure(androidx.media3.common.audio.AudioProcessor.AudioFormat)` and clears any buffered data and pending output.
`https://developer.android.com/reference/java/nio/ByteBuffer.html!` `@https://developer.android.com/reference/kotlin/androidx/annotation/CallSuper
https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor#getOutput()()`

Returns a buffer containing processed output data between its position and limit.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor#hasPendingOutput()()`

Returns whether the current output buffer has any data remaining.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `@https://developer.android.com/reference/kotlin/androidx/annotation/CallSuper
https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor#isEnded()()`

Returns whether this processor will return no more output from `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor#getOutput()` until `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor#flush()` has been called and more input has been queued.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[onFlush](https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor#onFlush())()`

**This function is deprecated.**

Use `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor#onFlush(androidx.media3.common.audio.AudioProcessor.StreamMetadata)` instead.

<br />

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor#queueEndOfStream()()`

Queues an end of stream signal.
`https://developer.android.com/reference/java/nio/ByteBuffer.html!` `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor#replaceOutputBuffer(int)(size: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

Replaces the current output buffer with a buffer of at least `size` bytes and returns it.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor#reset()()`

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

### Inherited properties

From [androidx.media3.common.audio.BaseAudioProcessor](https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor) `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor.AudioFormat!` `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor#inputAudioFormat()`

The current input audio format.
`https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor.AudioFormat!` `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor#outputAudioFormat()`

The current output audio format.

## Constants

### DEFAULT_MAX_SILENCE_TO_KEEP_DURATION_US

```
const val DEFAULT_MAX_SILENCE_TO_KEEP_DURATION_US = 2000000: Long
```

Default maximum silence to keep in microseconds. This maximum is applied after ` silenceRetentionRatio`.

### DEFAULT_MINIMUM_SILENCE_DURATION_US

```
const val DEFAULT_MINIMUM_SILENCE_DURATION_US = 100000: Long
```

Default minimum duration of audio that must be below `silenceThresholdLevel` before silence starts being trimmed. Specified in microseconds.

### DEFAULT_MIN_VOLUME_TO_KEEP_PERCENTAGE

```
const val DEFAULT_MIN_VOLUME_TO_KEEP_PERCENTAGE = 10: Int
```

Default volume percentage to keep.

Even when modifying the volume to a mute state, it is ideal to decrease the volume instead of making the volume zero. Completely silent audio sounds like playback has stopped. While decreased volume sounds like very light background noise at a recording studio.

### DEFAULT_PADDING_SILENCE_US

```
const val DEFAULT_PADDING_SILENCE_US = 20000: Long
```

> [!CAUTION]
> **This property is deprecated.**   
>
> Specify silence behaviour via `silenceRetentionRatio` instead.

### DEFAULT_SILENCE_RETENTION_RATIO

```
const val DEFAULT_SILENCE_RETENTION_RATIO = 0.2f: Float
```

Default fraction of the original silence to keep. Between \[0, 1\]. 1 means keep all silence. 0 means remove all silence.

### DEFAULT_SILENCE_THRESHOLD_LEVEL

```
const val DEFAULT_SILENCE_THRESHOLD_LEVEL = 1024: Short
```

Default absolute level below which an individual PCM sample is classified as silent.

## Public constructors

### SilenceSkippingAudioProcessor

```
SilenceSkippingAudioProcessor()
```

Creates a new silence skipping audio processor.

### SilenceSkippingAudioProcessor

```
[SilenceSkippingAudioProcessor](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#SilenceSkippingAudioProcessor(long,long,short))(
    minimumSilenceDurationUs: Long,
    paddingSilenceUs: Long,
    silenceThresholdLevel: Short
)
```

> [!CAUTION]
> **This function is deprecated.**   
>
> Use `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#SilenceSkippingAudioProcessor(long,float,long,int,short)` instead.

### SilenceSkippingAudioProcessor

```
SilenceSkippingAudioProcessor(
    minimumSilenceDurationUs: Long,
    silenceRetentionRatio: Float,
    maxSilenceToKeepDurationUs: Long,
    minVolumeToKeepPercentageWhenMuting: Int,
    silenceThresholdLevel: Short
)
```

Creates a new silence trimming audio processor.

| Parameters |
|---|---|
| `minimumSilenceDurationUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | Duration of audio that must be below ` silenceThresholdLevel` before silence starts being trimmed, in microseconds. |
| `silenceRetentionRatio: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | Fraction of the original silence to keep. Between \[0, 1\]. 1 means keep all silence. 0 means remove all silence. |
| `maxSilenceToKeepDurationUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | Maximum silence to keep in microseconds. This maximum is applied after `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#silenceRetentionRatio()`. |
| `minVolumeToKeepPercentageWhenMuting: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | Volume percentage to keep. Even when modifying the volume to a mute state, it is ideal to decrease the volume instead of making the volume zero. Completely silent audio sounds like playback has stopped. While decreased volume sounds like very light background noise from a recording studio. |
| `silenceThresholdLevel: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-short/index.html` | Absolute level below which an individual PCM sample is classified as silent. |

## Public functions

### isActive

```
fun isActive(): Boolean
```

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

### onFlush

```
fun onFlush(streamMetadata: AudioProcessor.StreamMetadata!): Unit
```

Called when the processor is `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor#flush(androidx.media3.common.audio.AudioProcessor.StreamMetadata)`.

### onQueueEndOfStream

```
fun onQueueEndOfStream(): Unit
```

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

### onReset

```
fun onReset(): Unit
```

Called when the processor is reset.

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

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

### setEnabled

```
fun setEnabled(enabled: Boolean): Unit
```

Sets whether to shorten silence in the input. This method may only be called after draining data through the processor. The value returned by `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/SilenceSkippingAudioProcessor#isActive()` may change, and the processor must be `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/BaseAudioProcessor#flush()` before queueing more data.

| Parameters |
|---|---|
| `enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether to shorten silence in the input. |

## Protected functions

### onConfigure

```
protected fun onConfigure(inputAudioFormat: AudioProcessor.AudioFormat!): AudioProcessor.AudioFormat!
```

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

| Throws |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/common/audio/AudioProcessor.UnhandledAudioFormatException` |   |

## Public properties

### skippedFrames

```
val skippedFrames: Long
```