Skip to content

Commit 5f3d6f3

Browse files
authored
added toc and small changes
1 parent c8221ac commit 5f3d6f3

File tree

3 files changed

+27
-23
lines changed

3 files changed

+27
-23
lines changed

articles/communication-services/concepts/voice-video-calling/calling-sdk-features.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ The following list presents the set of features that are currently available in
9999
| | Custom background image | ✔️ ||||
100100
| Audio Effects | [Music Mode](./music-mode.md) || ✔️ | ✔️ | ✔️ |
101101
| | [Audio filters](../../how-tos/calling-sdk/manage-audio-filters.md) || ✔️ | ✔️ | ✔️ |
102+
| | [Noise Supression](../../tutorials/audio-quality-enhancements/add-noise-supression.md) | ✔️ ||||
102103

103104

104105
<sup>1</sup> The capability to Mute Others is currently in public preview.

articles/communication-services/toc.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,10 @@ items:
286286
displayName: diagnostics, Survey, feedback, quality, reliability, users, end, call, quick
287287
- name: Collecting user feedback with the mobile UI Library
288288
href: tutorials/collecting-user-feedback/collecting-user-feedback.md
289+
- name: Audio quality enhancements
290+
items:
291+
- name: Enabling noise supression
292+
href: tutorials/audio-quality-enhancements/add-noise-supression.md
289293
- name: Virtual appointments
290294
items:
291295
- name: Sample builder

articles/communication-services/tutorials/audio-quality-enhancements.md renamed to articles/communication-services/tutorials/audio-quality-enhancements/add-noise-supression.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,28 @@ The `activeEffects` property returns an object with the names of the current act
6969
const currentActiveEffects = audioEffectsFeatureApi.activeEffects;
7070
```
7171

72+
### Start a call with Noise Suppression enabled
73+
To start a call with **noise suppression** turned on, you can create a new `LocalAudioStream` with a `AudioDeviceInfo` (the LocalAudioStream source <u>shouldn't</u> be a raw `MediaStream` to use audio effects), and pass it in the `CallStartOptions.audioOptions`:
74+
```js
75+
// As an example, here we are simply creating a LocalAudioStream using the current selected mic on the DeviceManager
76+
const audioDevice = deviceManager.selectedMicrophone;
77+
const localAudioStreamWithEffects = new SDK.LocalAudioStream(audioDevice);
78+
const audioEffectsFeatureApi = localAudioStreamWithEffects.feature(SDK.Features.AudioEffects);
79+
80+
// Start effect
81+
await audioEffectsFeatureApi.startEffects({
82+
noiseSuppression: deepNoiseSuppression
83+
});
84+
85+
// Pass the LocalAudioStream in audioOptions in call start/accept options.
86+
await call.startCall({
87+
audioOptions: {
88+
muted: false,
89+
localAudioStreams: [localAudioStreamWithEffects]
90+
}
91+
});
92+
```
93+
7294
### How to turn on Noise Suppression during an ongoing call
7395
There are situations where a user might start a call and not have **noise suppression** turned on, but their current environment might get noisy resulting in them needing to turn on **noise suppression**. To turn on **noise suppression**, you can use the `audioEffectsFeatureApi.startEffects` API.
7496
```js
@@ -90,27 +112,4 @@ await audioEffectsFeatureApi.startEffects({
90112
await audioEffectsFeatureApi.stopEffects({
91113
noiseSuppression: true
92114
});
93-
```
94-
95-
96-
### Start a call with Noise Suppression enabled
97-
To start a call with **noise suppression** turned on, you can create a new `LocalAudioStream` with a `AudioDeviceInfo` (the LocalAudioStream source <u>shouldn't</u> be a raw `MediaStream` to use audio effects), and pass it in the `CallStartOptions.audioOptions`:
98-
```js
99-
// As an example, here we are simply creating a LocalAudioStream using the current selected mic on the DeviceManager
100-
const audioDevice = deviceManager.selectedMicrophone;
101-
const localAudioStreamWithEffects = new SDK.LocalAudioStream(audioDevice);
102-
const audioEffectsFeatureApi = localAudioStreamWithEffects.feature(SDK.Features.AudioEffects);
103-
104-
// Start effect
105-
await audioEffectsFeatureApi.startEffects({
106-
noiseSuppression: deepNoiseSuppression
107-
});
108-
109-
// Pass the LocalAudioStream in audioOptions in call start/accept options.
110-
await call.startCall({
111-
audioOptions: {
112-
muted: false,
113-
localAudioStreams: [localAudioStreamWithEffects]
114-
}
115-
});
116115
```

0 commit comments

Comments
 (0)