Enable Echo Cancellation

Enables echo cancellation on an active call, so audio played through the speakers is not picked back up by the microphone and sent to the remote party as an echo.

This enables the browser's built-in echoCancellation audio processing on the call's microphone track.

Signature

enableEchoCancellation(callId: string): Promise<void>

Parameters

Parameter	Type	Required	Description
callId	string	Yes	Identifier of the active call

Return Type

Returns a Promise that resolves once the constraint has been applied.

Usage Example

const callId = 'callId';
await client.enableEchoCancellation(callId);

Errors

Error Type	Error Code	Description
INTERNAL_ERROR	media:error:track_not_found	No active call or no outgoing audio track found for provided callId
UNKNOWN_ERROR	N/A	Unexpected failure

For complete error reference and handling guidelines, see Error Reference.

Notes

• Web only. Android and iOS do not expose echo cancellation as a call action
• Currently marked experimental
• Requires an active call — call this once media is established
• Browsers enable echo cancellation by default, so this is mainly useful to restore it after disableEchoCancellation
• Changing one audio processing constraint preserves the other two

Related Actions

• disableEchoCancellation - Disable echo cancellation for an active call
• enableNoiseSuppression - Filter background noise from the microphone input
• enableAutoGainControl - Even out microphone input volume

Related Events

• onCallMediaError - Fired when media errors occur during a call
• onRTCStatsUpdate - Reports echoReturnLoss and echoReturnLossEnhancement, which measure how much echo is being cancelled