Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Key traits that noise suppression enables:
- Typically works on the speaker’s end before sending out the audio.

**Echo cancellation** removes echo caused when your microphone picks up audio from your speakers. For example, when someone is on speakerphone and their microphone picks up your voice from their speaker, it can loop back to you as an echo. Echo cancellation predicts and subtracts this returning sound so you don’t hear yourself talking back a fraction of a second later.
Key traits for echo cancelation:
Key traits for echo cancellation:
- Reduces acoustic feedback.
- Essential in open microphone and desktop setups where the microphone picks up audio output from a local speaker.
- Reduces listener fatigue and confusion caused by hearing your own voice returned.
Expand All @@ -35,7 +35,7 @@ Key traits for echo cancelation:
> **Noise Suppression** features are available in GA WebJS SDK version `1.28.4` or later, alongside the Azure Communication Services Calling Effects SDK version GA `1.1.2` or later. Alternatively, if you opt to use the public preview version, Calling SDK versions `1.24.2-beta.1` and later also support noise suppression.

> [!IMPORTANT]
> **Echo Cancellation** features are available in GA WebJS SDK version [1.38.1](https://github.com/Azure/Communication/blob/master/releasenotes/acs-javascript-calling-library-release-notes.md#1381-2025-09-02) or later. Also note that to use echo cancelation you must use the audio effects SDK version GA version [1.31.1](https://www.npmjs.com/package/@azure/communication-calling-effects/v/1.3.1) or later. Alternatively, if you opt to use the public preview version, Calling SDK versions [1.38.1-beta.1](https://github.com/Azure/Communication/blob/master/releasenotes/acs-javascript-calling-library-release-notes.md#1381-beta1-2025-07-21) and later also support noise suppression.
> **Echo Cancellation** features are available in GA WebJS SDK version [1.38.1](https://github.com/Azure/Communication/blob/master/releasenotes/acs-javascript-calling-library-release-notes.md#1381-2025-09-02) or later. Also note that to use echo cancellation you must use the audio effects SDK version GA version [1.31.1](https://www.npmjs.com/package/@azure/communication-calling-effects/v/1.3.1) or later. Alternatively, if you opt to use the public preview version, Calling SDK versions [1.38.1-beta.1](https://github.com/Azure/Communication/blob/master/releasenotes/acs-javascript-calling-library-release-notes.md#1381-beta1-2025-07-21) and later also support noise suppression.

> [!NOTE]
> - Utilizing audio effects is available only on Chrome and Edge desktop browsers.
Expand Down Expand Up @@ -158,8 +158,8 @@ if (isNoiseSuppressionSupported) {
}
```

## Bring it all together: Load and start noise suppression and echo cancelation
To initiate a call with both **noise suppression** and **echo cancelation** enabled, create a new `LocalAudioStream` property using `AudioDeviceInfo`. Ensure that the `LocalAudioStream` source isn't set as a raw `MediaStream` property to support audio effects. Then, include this property within `CallStartOptions.audioOptions` when starting the call.
## Bring it all together: Load and start noise suppression and echo cancellation
To initiate a call with both **noise suppression** and **echo cancellation** enabled, create a new `LocalAudioStream` property using `AudioDeviceInfo`. Ensure that the `LocalAudioStream` source isn't set as a raw `MediaStream` property to support audio effects. Then, include this property within `CallStartOptions.audioOptions` when starting the call.

```js
import { EchoCancellationEffect, DeepNoiseSuppressionEffect } from '@azure/communication-calling-effects';
Expand Down Expand Up @@ -230,14 +230,14 @@ await audioEffectsFeatureApi.stopEffects({
});
```

#### To start Azure Communication Services echo cancelation
#### To start Azure Communication Services echo cancellation
```js
await audioEffectsFeatureApi.startEffects({
noiseSuppression: echoCancellation
});
```

#### To stop Azure Communication Services echo cancelation
#### To stop Azure Communication Services echo cancellation
```js
await audioEffectsFeatureApi.stopEffects({
echoCancellation: true
Expand Down