Skip to navigation

setAutoGainControl

View as MarkdownOpen in Claude
setAutoGainControl(enabled): Promise<boolean>

Toggle browser automatic gain control on the local mic at runtime.

Parameters

enabled
booleanRequired

Whether automatic gain control should be enabled.

Returns

Promise<boolean> — whether the constraint reached the microphone.

false is an outcome rather than an error: a leg sending media the SDK did not capture is left alone. A UI that reflects the toggle must read this value instead of assuming the call succeeded. Any failure behind a false is also reported on errors$.

Examples

Toggle from a UI switch

agcSwitch.addEventListener('change', async (e) => {
await call.setAutoGainControl(e.target.checked);
});

See