# AudioOutputProvider

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/AudioOutputProvider.java+class:androidx.media3.exoplayer.audio.AudioOutputProvider)

*** ** * ** ***


```
interface AudioOutputProvider
```

<br />

Known direct subclasses [AudioTrackAudioOutputProvider](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioTrackAudioOutputProvider), [ForwardingAudioOutputProvider](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/ForwardingAudioOutputProvider)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioTrackAudioOutputProvider` | A default implementation of `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider`. |
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/ForwardingAudioOutputProvider` | A forwarding base class that delegates all calls to the provided `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider`. |

*** ** * ** ***

A provider for `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutput` instances and for querying their support.

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.ConfigurationException : https://developer.android.com/reference/java/lang/Exception.html` Thrown when a failure occurs configuring the output. |
| `class https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatConfig` Configuration for an audio format and its output preferences. |
| `class https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatConfig.Builder` Builder for `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatConfig` instances. |
| `class https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatSupport` Level of support for an audio format by the provider. |
| `class https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatSupport.Builder` A builder to create `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatSupport` instances. |
| `class https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.InitializationException : https://developer.android.com/reference/java/lang/Exception.html` Thrown when a failure occurs initializing the output. |
| `interface https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.Listener` Listener for `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider` events. |
| `class https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.OutputConfig` Configuration for an `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutput`. |
| `class https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.OutputConfig.Builder` Builder for `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.OutputConfig` instances. |
| `@https://developer.android.com/reference/java/lang/annotation/Documented.html @https://developer.android.com/reference/java/lang/annotation/Retention.html(value = https://developer.android.com/reference/java/lang/annotation/RetentionPolicy.html#SOURCE) @https://developer.android.com/reference/java/lang/annotation/Target.html(value = https://developer.android.com/reference/java/lang/annotation/ElementType.html#TYPE_USE) @https://developer.android.com/reference/kotlin/androidx/annotation/IntDef(value = ) annotation https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.SupportLevel` The level of support the provider has for a format. |

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider#FORMAT_SUPPORTED_DIRECTLY() = 2` The provider supports the format directly, without the need for internal transcoding. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider#FORMAT_SUPPORTED_WITH_TRANSCODING() = 1` The provider supports the format, but needs to transcode it internally to do so. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider#FORMAT_UNSUPPORTED() = 0` The provider does not support the format. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider#addListener(androidx.media3.exoplayer.audio.AudioOutputProvider.Listener)(listener: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.Listener!)` Adds a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.Listener`. |
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutput!` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider#getAudioOutput(androidx.media3.exoplayer.audio.AudioOutputProvider.OutputConfig)(config: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.OutputConfig!)` Returns an `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutput` for the given config. |
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatSupport!` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider#getFormatSupport(androidx.media3.exoplayer.audio.AudioOutputProvider.FormatConfig)(formatConfig: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatConfig!)` Returns the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatSupport` that this provider has for a given `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatConfig`. |
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.OutputConfig!` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider#getOutputConfig(androidx.media3.exoplayer.audio.AudioOutputProvider.FormatConfig)(formatConfig: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatConfig!)` Returns the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.OutputConfig` for the given format. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider#hasPendingReleases()()` Returns whether there are any pending asynchronous releases of audio outputs. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider#release()()` Releases resources held by the provider. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider#removeListener(androidx.media3.exoplayer.audio.AudioOutputProvider.Listener)(listener: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.Listener!)` Removes a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.Listener`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider#setClock(androidx.media3.common.util.Clock)(clock: https://developer.android.com/reference/kotlin/androidx/media3/common/util/Clock!)` Sets the `https://developer.android.com/reference/kotlin/androidx/media3/common/util/Clock` to use in the provider. |

## Constants

### FORMAT_SUPPORTED_DIRECTLY

```
const val FORMAT_SUPPORTED_DIRECTLY = 2: Int
```

The provider supports the format directly, without the need for internal transcoding.

### FORMAT_SUPPORTED_WITH_TRANSCODING

```
const val FORMAT_SUPPORTED_WITH_TRANSCODING = 1: Int
```

The provider supports the format, but needs to transcode it internally to do so. Internal transcoding may result in lower quality and higher CPU load in some cases.

### FORMAT_UNSUPPORTED

```
const val FORMAT_UNSUPPORTED = 0: Int
```

The provider does not support the format.

## Public functions

### addListener

```
fun addListener(listener: AudioOutputProvider.Listener!): Unit
```

Adds a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.Listener`.

| Parameters |
|---|---|
| `listener: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.Listener!` | The listener to add. |

### getAudioOutput

```
fun getAudioOutput(config: AudioOutputProvider.OutputConfig!): AudioOutput!
```

Returns an `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutput` for the given config.

| Parameters |
|---|---|
| `config: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.OutputConfig!` | The `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.OutputConfig`. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutput!` | The `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutput`. |

| Throws |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.InitializationException` |   |

### getFormatSupport

```
fun getFormatSupport(formatConfig: AudioOutputProvider.FormatConfig!): AudioOutputProvider.FormatSupport!
```

Returns the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatSupport` that this provider has for a given `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatConfig`.

| Parameters |
|---|---|
| `formatConfig: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatConfig!` | The `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatConfig`. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatSupport!` | The `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatSupport` for this config. |

### getOutputConfig

```
fun getOutputConfig(formatConfig: AudioOutputProvider.FormatConfig!): AudioOutputProvider.OutputConfig!
```

Returns the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.OutputConfig` for the given format.

| Parameters |
|---|---|
| `formatConfig: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatConfig!` | The `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.FormatConfig`. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.OutputConfig!` | The `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.OutputConfig` for this format. |

| Throws |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.ConfigurationException` |   |

### hasPendingReleases

```
@UnstableApi
fun hasPendingReleases(): Boolean
```

Returns whether there are any pending asynchronous releases of audio outputs.

Implementations that release resources synchronously should return false.

### release

```
fun release(): Unit
```

Releases resources held by the provider.

### removeListener

```
fun removeListener(listener: AudioOutputProvider.Listener!): Unit
```

Removes a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.Listener`.

| Parameters |
|---|---|
| `listener: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider.Listener!` | The listener to remove. |

### setClock

```
@UnstableApi
fun setClock(clock: Clock!): Unit
```

Sets the `https://developer.android.com/reference/kotlin/androidx/media3/common/util/Clock` to use in the provider.