Skip to content

Commit 376cbc5

Browse files
authored
Merge pull request #286559 from sloanster/patch-22
Update web.md
2 parents eff2e78 + e3304a8 commit 376cbc5

File tree

1 file changed

+20
-18
lines changed
  • articles/communication-services/tutorials/audio-quality-enhancements/includes

1 file changed

+20
-18
lines changed

articles/communication-services/tutorials/audio-quality-enhancements/includes/web.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,37 @@ author: sloanster
66
ms.author: micahvivion
77

88
services: azure-communication-services
9-
ms.date: 05/02/2024
9+
ms.date: 09/11/2024
1010
ms.topic: include
1111
ms.service: azure-communication-services
1212
ms.subservice: calling
1313
---
1414

1515
The Azure Communication Services audio effects **noise suppression** abilities can improve your audio calls by filtering out unwanted background noises. **Noise suppression** is a technology that removes background noises from audio calls. It makes audio calls clearer and better by eliminating background noise, making it easier to talk and listen. Noise suppression can also reduce distractions and tiredness caused by noisy places. For example, if you're taking an Azure Communication Services WebJS call in a coffee shop with considerable noise, turning on noise suppression can make the call experience better.
1616

17-
[!INCLUDE [Public Preview Disclaimer](../../../includes/public-preview-include-document.md)]
18-
19-
## Using audio effects - **noise suppression**
17+
## Using audio effects - **Noise Suppression**
2018
### Install the npm package
21-
Use the `npm install` command to install the Azure Communication Services Audio Effects SDK for JavaScript.
2219
> [!IMPORTANT]
23-
> This tutorial uses the Azure Communication Services Calling SDK version of **`1.24.2-beta.1`** (or greater) and the Azure Communication Services Calling Audio Effects SDK version greater than or equal to **`1.1.1-beta.1`** (or greater).
24-
25-
```console
26-
27-
```
20+
> This tutorial employs the Azure Communication Services Calling SDK version `1.28.4` or later, alongside the Azure Communication > Services Calling Effects SDK version `1.1.1` or newer. The GA (stable) version **`1.28.4`** and above of the calling SDK support noise suppression features. Alternatively, if you opt to use the public preview version, calling SDK versions `1.24.2-beta.1` and higher also support noise suppression.
21+
>
22+
> Current browser support for adding audio noise suppression effects is only available on Chrome and Edge Desktop browsers.
2823
29-
> [!NOTE]
30-
> The calling effect library cannot be used standalone and can only work when used with the Azure Communication Calling client library for WebJS (https://www.npmjs.com/package/@azure/communication-calling).
24+
> [!IMPORTANT]
25+
> The calling effects library cannot be used standalone and can only work when used with the Azure Communication Calling client library for WebJS.
3126
32-
You can find more [details ](https://www.npmjs.com/package/@azure/communication-calling-effects/v/next) on the calling effects npm package page.
27+
Use the `npm install` command to install the Azure Communication Services Audio Effects SDK for JavaScript.
3328

3429
> [!NOTE]
35-
> Current browser support for adding audio noise suppression effects is only available on Chrome and Edge Desktop Browsers.
30+
> If you are using the GA version of the calling SDK you must use the [GA version](https://www.npmjs.com/package/@azure/communication-calling-effects/v/1.1.1) of the effects SDK.
31+
```console
32+
33+
```
3634

37-
> You can learn about the specifics of the [calling API](/javascript/api/azure-communication-services/@azure/communication-calling/?view=azure-communication-services-js&preserve-view=true).
35+
> [!NOTE]
36+
> If you are using the public preview of the calling SDK you must use the [beta version](https://www.npmjs.com/package/@azure/communication-calling-effects/v/1.1.1-beta.2) of the effects SDK.
37+
```console
38+
39+
```
3840

3941
To use `noise suppression` audio effects within the Azure Communication Calling SDK, you need the `LocalAudioStream` that is currently in the call. You need access to the `AudioEffects` API of the `LocalAudioStream` to start and stop audio effects.
4042
```js
@@ -46,7 +48,7 @@ import { DeepNoiseSuppressionEffect } from '@azure/communication-calling-effects
4648
const localAudioStreamInCall = call.localAudioStreams[0];
4749

4850
// Get the audio effects feature API from LocalAudioStream
49-
const audioEffectsFeatureApi = localAudioStreamInCall.feature(SDK.Features.AudioEffects);
51+
const audioEffectsFeatureApi = localAudioStreamInCall.feature(AzureCommunicationCallingSDK.Features.AudioEffects);
5052

5153
// Subscribe to useful events that show audio effects status
5254
audioEffectsFeatureApi.on('effectsStarted', (activeEffects: ActiveAudioEffects) => {
@@ -76,8 +78,8 @@ To start a call with **noise suppression** turned on, you can create a new `Loca
7678
```js
7779
// As an example, here we are simply creating a LocalAudioStream using the current selected mic on the DeviceManager
7880
const audioDevice = deviceManager.selectedMicrophone;
79-
const localAudioStreamWithEffects = new SDK.LocalAudioStream(audioDevice);
80-
const audioEffectsFeatureApi = localAudioStreamWithEffects.feature(SDK.Features.AudioEffects);
81+
const localAudioStreamWithEffects = new .LocalAudioStream(audioDevice);
82+
const audioEffectsFeatureApi = localAudioStreamWithEffects.feature(AzureCommunicationCallingSDK.Features.AudioEffects);
8183

8284
// Start effect
8385
await audioEffectsFeatureApi.startEffects({

0 commit comments

Comments
 (0)