livekit-android-sdk/io.livekit.android/AudioOptions

AudioOptions

class AudioOptions(val audioOutputType: AudioType? = null, val audioHandler: AudioHandler? = null, val audioDeviceModule: AudioDeviceModule? = null, val javaAudioDeviceModuleCustomizer: (builder: JavaAudioDeviceModule.Builder) -> Unit? = null, val disableCommunicationModeWorkaround: Boolean = false, val audioProcessorOptions: AudioProcessorOptions? = null, val disableAudioPrewarming: Boolean = false)

Options for customizing the audio settings of LiveKit.

Constructors

AudioOptions

constructor(audioOutputType: AudioType? = null, audioHandler: AudioHandler? = null, audioDeviceModule: AudioDeviceModule? = null, javaAudioDeviceModuleCustomizer: (builder: JavaAudioDeviceModule.Builder) -> Unit? = null, disableCommunicationModeWorkaround: Boolean = false, audioProcessorOptions: AudioProcessorOptions? = null, disableAudioPrewarming: Boolean = false)

Properties

audioDeviceModule

val audioDeviceModule: AudioDeviceModule? = null

Override the default AudioDeviceModule.

audioHandler

val audioHandler: AudioHandler? = null

Override the default AudioHandler.

audioOutputType

val audioOutputType: AudioType? = null

Override the default output AudioType.

audioProcessorOptions

val audioProcessorOptions: AudioProcessorOptions? = null

Options for processing the mic and incoming audio.

disableAudioPrewarming

val disableAudioPrewarming: Boolean = false

Devices may take some time initializing the audio stack for recording. Prewarming allows starting up the underlying audio recording prior to publish, letting the audio device be ready immediately when the track is fully published.

disableCommunicationModeWorkaround

val disableCommunicationModeWorkaround: Boolean = false

On Android 11+, the audio mode will reset itself from AudioManager.MODE_IN_COMMUNICATION if there is no audio playback or capture for 6 seconds (for example when joining a room with no speakers and the local mic is muted.) This mode reset will cause unexpected behavior when trying to change the volume, causing it to not properly change the volume.

javaAudioDeviceModuleCustomizer

val javaAudioDeviceModuleCustomizer: (builder: JavaAudioDeviceModule.Builder) -> Unit? = null

Called after default setup to allow for customizations on the JavaAudioDeviceModule.