AudioOutputProvider.FormatConfig


class AudioOutputProvider.FormatConfig


Configuration for an audio format and its output preferences.

Summary

Nested types

Builder for FormatConfig instances.

Public functions

AudioOutputProvider.FormatConfig.Builder!

Returns a Builder initialized with the values of this instance.

Public properties

AudioAttributes!

The AudioAttributes to use for playback.

Int

The audio session ID, or AUDIO_SESSION_ID_UNSET if not set.

Boolean

Sets whether to enable high resolution PCM output with more than 16 bits.

Boolean

Whether the audio output should enable offload.

Boolean

Whether to control the playback speed using the audio output.

Boolean

Whether tunneling is enabled.

Format!

The Format of the audio.

Int

The preferred buffer size in bytes, or LENGTH_UNSET if no preference is specified.

AudioDeviceInfo?

The preferred AudioDeviceInfo for audio output, or null for no preference.

Int

The virtual device ID, or INDEX_UNSET if not specified.

Public functions

buildUpon

fun buildUpon(): AudioOutputProvider.FormatConfig.Builder!

Returns a Builder initialized with the values of this instance.

Public properties

audioAttributes

val audioAttributes: AudioAttributes!

The AudioAttributes to use for playback.

audioSessionId

val audioSessionId: Int

The audio session ID, or AUDIO_SESSION_ID_UNSET if not set.

This parameter should not generally affect the outcome of getFormatSupport.

enableHighResolutionPcmOutput

val enableHighResolutionPcmOutput: Boolean

Sets whether to enable high resolution PCM output with more than 16 bits.

enableOffload

val enableOffload: Boolean

Whether the audio output should enable offload.

This parameter should not generally affect the outcome of getFormatSupport.

enablePlaybackParameters

val enablePlaybackParameters: Boolean

Whether to control the playback speed using the audio output.

This parameter should not generally affect the outcome of getFormatSupport.

enableTunneling

val enableTunneling: Boolean

Whether tunneling is enabled.

This parameter should not generally affect the outcome of getFormatSupport.

format

val format: Format!

The Format of the audio.

preferredBufferSize

val preferredBufferSize: Int

The preferred buffer size in bytes, or LENGTH_UNSET if no preference is specified.

This parameter should not generally affect the outcome of getFormatSupport.

preferredDevice

val preferredDevice: AudioDeviceInfo?

The preferred AudioDeviceInfo for audio output, or null for no preference.

virtualDeviceId

val virtualDeviceId: Int

The virtual device ID, or INDEX_UNSET if not specified.

This parameter should not generally affect the outcome of getFormatSupport.