You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/communication-services/tutorials/audio-quality-enhancements/includes/web.md
+51-29Lines changed: 51 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ Use the `npm install` command to install the Azure Communication Services Audio
49
49
@azure/communication-calling-effects/v/latest
50
50
```
51
51
52
-
If you use the **public preview** of the Calling SDK, you must use the [beta version](https://www.npmjs.com/package/@azure/communication-calling-effects/v/next) of the Calling Effects SDK.
52
+
If you use the **public preview** of the Calling SDK, you must use the [beta version](https://www.npmjs.com/package/@azure/communication-calling-effects/v/next) of the Calling Effects SDK. Use the `npm install` command to install the Azure Communication Services Audio Effects SDK for JavaScript.
53
53
54
54
```console
55
55
@azure/communication-calling-effects/v/next
@@ -60,25 +60,35 @@ For information on the interface that details audio effects properties and metho
60
60
61
61
62
62
### Initialize the Audio Effects Feature
63
-
To use noise suppression audio effects within the Azure Communication Services Calling SDK, you need the `LocalAudioStream` property that's currently in the call. You need access to the `AudioEffects` API of the `LocalAudioStream` property to start and stop audio effects.
This wraps the standard CallClient with audio effects capabilities.
63
+
To use audio effects within the Azure Communication Services Calling SDK, you need the `LocalAudioStream` property that's currently in the call. You need access to the `AudioEffects` API of the `LocalAudioStream` property to start and stop audio effects.
70
64
71
65
### Enable Noise Suppression
72
66
The following code snippet shows an example on how to enable **noise suppression** from within the Webjs environment.
### To start or stop audio effects packages during a call
174
-
To start Azure Communication Services Deep Noise Suppression
183
+
### To start or stop audio effects packages during an active call
184
+
You might start a call and not have noise suppression turned on. The end users room might get noisy so that they would need to turn on noise suppression. To turn on noise suppression, you can use the `audioEffectsFeatureApi.startEffects` AP
185
+
186
+
#### To start Azure Communication Services Noise Suppression
175
187
```js
176
188
awaitaudioEffectsFeatureApi.startEffects({
177
189
noiseSuppression: deepNoiseSuppression
178
190
});
179
191
```
180
192
181
-
To stop Azure Communication Services Deep Noise Suppression
193
+
#### To stop Azure Communication Services Deep Noise Suppression
182
194
```js
183
195
awaitaudioEffectsFeatureApi.stopEffects({
184
196
noiseSuppression:true
185
197
});
186
198
```
187
199
188
-
To start Azure Communication Services echo cancelation
200
+
#### To start Azure Communication Services echo cancelation
189
201
```js
190
202
awaitaudioEffectsFeatureApi.startEffects({
191
203
noiseSuppression: echoCancellation
192
204
});
193
205
```
194
206
195
-
To stop Azure Communication Services echo cancelation
207
+
#### To stop Azure Communication Services echo cancelation
To check what noise suppression effects are currently active, you can use the `activeEffects` property. The `activeEffects` property returns an object with the names of the current active effects.
console.log(`Error with audio effects: ${error.message}`);
239
+
});
218
240
```
219
241
## Best Practices
220
242
The Azure Communication Services WebJS audio effects package provides tools for reducing unwanted sounds. Other measures can be taken to improve audio quality, such as:
0 commit comments