Struct AudioProcessingOptions 

pub struct AudioProcessingOptions {
    pub echo_cancellation: bool,
    pub noise_suppression: bool,
    pub auto_gain_control: bool,
    pub prefer_hardware_processing: bool,
}

Configuration options for audio processing (AEC, AGC, NS).

Platform Behavior

• iOS: Hardware processing via VPIO is always used and provides excellent AEC/AGC/NS. The prefer_hardware_processing default is true on iOS.

• Android: Hardware AEC quality varies significantly across manufacturers and device models. Many devices have broken or poorly-tuned hardware AEC. The default is false to use WebRTC’s reliable software processing. See: https://github.com/react-native-webrtc/react-native-webrtc/issues/713

• Desktop (macOS, Windows, Linux): Hardware processing is not available. WebRTC’s software Audio Processing Module (APM) is always used. The prefer_hardware_processing setting is ignored.

Example

use livekit::AudioProcessingOptions;

// Use platform-appropriate defaults
let opts = AudioProcessingOptions::default();

// Disable echo cancellation
let opts = AudioProcessingOptions {
    echo_cancellation: false,
    ..Default::default()
};

// Force software processing on iOS (not recommended)
let opts = AudioProcessingOptions {
    prefer_hardware_processing: false,
    ..Default::default()
};

Fields

echo_cancellation: bool

Enable echo cancellation.

Echo cancellation removes acoustic echo from the microphone signal, which occurs when the speaker output is picked up by the microphone.

Default: true

noise_suppression: bool

Enable noise suppression.

Noise suppression reduces background noise in the microphone signal.

Default: true

auto_gain_control: bool

Enable automatic gain control.

AGC automatically adjusts the microphone volume to maintain consistent audio levels.

Default: true

prefer_hardware_processing: bool

Prefer hardware audio processing when available.

Platform Defaults

• iOS: true - VPIO hardware processing is excellent and always used. Apple’s Voice Processing IO unit provides reliable, low-latency AEC/AGC/NS that is tightly integrated with the audio hardware.

• Android: false - Hardware AEC is unreliable on many devices. Quality varies significantly across manufacturers (Samsung, Xiaomi, etc.) and even across models from the same manufacturer. WebRTC’s software AEC provides consistent behavior across all Android devices. Reference: Meta found hardware AEC “broken on many combinations of HW + OS” when supporting billions of users across thousands of device models.

• Desktop: false - Hardware processing is not available. This setting is ignored; WebRTC software APM is always used.

Trait Implementations

impl Clone for AudioProcessingOptions

fn clone(&self) -> AudioProcessingOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for AudioProcessingOptions

impl Debug for AudioProcessingOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AudioProcessingOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for AudioProcessingOptions

impl PartialEq for AudioProcessingOptions

fn eq(&self, other: &AudioProcessingOptions) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for AudioProcessingOptions