Struct AudioProcessingOptions

Namespace

LiveKit

Options for libwebrtc's audio processing. Used by PlatformAudioSource, where the ADM applies them, and by Unity-audio sources such as MicrophoneSource created with options, where the SDK runs libwebrtc's audio processing module over the capture with the mix Unity plays as the echo reference (see PlayoutReference).

public struct AudioProcessingOptions

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

FfiRequestExtensions.InitializeRequestAsyncId<T>(T)

Fields

AutoGainControl

Enable automatic gain control (AGC). Default: true.

public bool AutoGainControl

Field Value

bool

EchoCancellation

Enable echo cancellation (AEC). Default: true.

public bool EchoCancellation

Field Value

bool

NoiseSuppression

Enable noise suppression (NS). Default: true.

public bool NoiseSuppression

Field Value

bool

PreferHardware

Prefer hardware audio processing (e.g., iOS VPIO). Lower latency. PlatformAudioSource only. Default: true.

public bool PreferHardware

Field Value

bool

Properties

Default

Default audio processing options with all processing enabled and hardware preferred.

public static AudioProcessingOptions Default { get; }

Property Value

AudioProcessingOptions