Skip to content

Commit 770ea9c

Browse files
authored
Merge pull request #288744 from paulth1/add-noise-suppression
[AQ] edit pass: Add noise suppression
2 parents 1abb228 + 74e7f74 commit 770ea9c

File tree

8 files changed

+102
-86
lines changed

8 files changed

+102
-86
lines changed

articles/communication-services/how-tos/calling-sdk/includes/install-sdk/install-sdk-ios.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ ms.author: rifox
88

99
## Set up your system
1010

11+
Follow these steps to set up your system.
12+
1113
### Create the Xcode project
1214

1315
In Xcode, create a new iOS project and select the **Single View App** template. This article uses the [SwiftUI framework](https://developer.apple.com/xcode/swiftui/), so you should set **Language** to **Swift** and set **Interface** to **SwiftUI**.
@@ -28,13 +30,13 @@ You're not going to create tests in this article. Feel free to clear the **Inclu
2830
end
2931
```
3032
31-
2. Run `pod install`.
33+
1. Run `pod install`.
3234
33-
3. Open `.xcworkspace` by using Xcode.
35+
1. Open `.xcworkspace` by using Xcode.
3436
3537
### Request access to the microphone
3638
37-
To access the device's microphone, you need to update your app's information property list by using `NSMicrophoneUsageDescription`. You set the associated value to a string that will be included in the dialog that the system uses to request access from the user.
39+
To access the device's microphone, you need to update your app's information property list by using `NSMicrophoneUsageDescription`. Set the associated value to a string that's included in the dialog that the system uses to request access from the user.
3840
3941
Right-click the **Info.plist** entry of the project tree, and then select **Open As** > **Source Code**. Add the following lines in the top-level `<dict>` section, and then save the file.
4042
@@ -45,7 +47,7 @@ Right-click the **Info.plist** entry of the project tree, and then select **Open
4547

4648
### Set up the app framework
4749

48-
Open your project's `ContentView.swift` file. Add an `import` declaration to the top of the file to import the `AzureCommunicationCalling` library. In addition, import `AVFoundation`. You'll need it for audio permission requests in the code.
50+
Open your project's `ContentView.swift` file. Add an `import` declaration to the top of the file to import the `AzureCommunicationCalling` library. In addition, import `AVFoundation`. You need it for audio permission requests in the code.
4951

5052
```swift
5153
import AzureCommunicationCalling

articles/communication-services/how-tos/calling-sdk/includes/install-sdk/install-sdk-windows.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,23 @@ ms.author: jowang
77
---
88
## Set up your system
99

10+
Follow these steps to set up your system.
11+
1012
### Create the Visual Studio project
1113

12-
For a Universal Windows Platform (UWP) app, in Visual Studio 2022, create a new **Blank App (Universal Windows)** project. After you enter the project name, feel free to choose any Windows SDK later than 10.0.17763.0.
14+
For a Universal Windows Platform app, in Visual Studio 2022, create a new **Blank App (Universal Windows)** project. After you enter the project name, feel free to choose any Windows SDK later than 10.0.17763.0.
1315

1416
For a WinUI 3 app, create a new project with the **Blank App, Packaged (WinUI 3 in Desktop)** template to set up a single-page WinUI 3 app. [Windows App SDK version 1.3](/windows/apps/windows-app-sdk/stable-channel#version-13) or later is required.
1517

1618
### Install the package and dependencies by using NuGet Package Manager
1719

1820
The Calling SDK APIs and libraries are publicly available via a NuGet package.
1921

20-
The following steps exemplify how to find, download, and install the Calling SDK NuGet package:
22+
To find, download, and install the Calling SDK NuGet package:
2123

2224
1. Open NuGet Package Manager by selecting **Tools** > **NuGet Package Manager** > **Manage NuGet Packages for Solution**.
23-
2. Select **Browse**, and then enter `Azure.Communication.Calling.WindowsClient` in the search box.
24-
3. Make sure that the **Include prerelease** check box is selected.
25-
4. Select the `Azure.Communication.Calling.WindowsClient` package, and then select `Azure.Communication.Calling.WindowsClient` [1.4.0-beta.1](https://www.nuget.org/packages/Azure.Communication.Calling.WindowsClient/1.4.0-beta.1) or a newer version.
26-
5. Select the checkbox that corresponds to the Communication Services project on the right-side tab.
27-
6. Select the **Install** button.
25+
1. Select **Browse**, and then enter **Azure.Communication.Calling.WindowsClient** in the search box.
26+
1. Make sure that the **Include prerelease** checkbox is selected.
27+
1. Select the **Azure.Communication.Calling.WindowsClient** package, and then select **Azure.Communication.Calling.WindowsClient** [1.4.0-beta.1](https://www.nuget.org/packages/Azure.Communication.Calling.WindowsClient/1.4.0-beta.1) or a newer version.
28+
1. Select the checkbox that corresponds to the Azure Communication Services project on the right pane.
29+
1. Select **Install**.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Tutorial - Add audio filters to improve the quality in your audio calling experience
2+
title: 'Tutorial: Add audio filters to improve the quality in your audio calling experience'
33
titleSuffix: An Azure Communication Services tutorial on how to enable advanced audio filters
4-
description: Learn how to add audio effects in your calls using Azure Communication Services.
4+
description: Learn how to add audio effects in your calls by using Azure Communication Services.
55
author: sloanster
66

77
ms.author: micahvivion

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Tutorial - Add audio effects suppression ability to your Android apps
2+
title: 'Tutorial: Add audio effects suppression ability to your Android apps'
33
titleSuffix: An Azure Communication Services tutorial on how to enable audio effects
4-
description: Learn how to add audio effects in your calls using Azure Communication Services.
4+
description: Learn how to add audio effects in your calls by using Azure Communication Services.
55
author: zehangzheng
66

77
ms.date: 10/6/2023
@@ -16,7 +16,7 @@ ms.subservice: calling
1616

1717
[!INCLUDE [Install SDK](../../../how-tos/calling-sdk/includes/install-sdk/install-sdk-android.md)]
1818

19-
The audio filter feature enables you to apply different audio preprocessing options to outgoing audio. There are two types of audio filters: `OutgoingAudioFilters` and `LiveOutgoingAudioFilters`. Use `OutgoingAudioFilters` to change settings before the call starts and `LiveOutgoingAudioFilters` to change settings while a call is in progress.
19+
You can use the audio filter feature to apply different audio preprocessing options to outgoing audio. The two types of audio filters are `OutgoingAudioFilters` and `LiveOutgoingAudioFilters`. Use `OutgoingAudioFilters` to change settings before the call starts. Use `LiveOutgoingAudioFilters` to change settings while a call is in progress.
2020

2121
You first need to import the Calling SDK and the associated classes:
2222

@@ -26,11 +26,11 @@ import com.azure.android.communication.calling.OutgoingAudioFilters;
2626
import com.azure.android.communication.calling.LiveOutgoingAudioFilters;
2727
```
2828

29-
## Before call starts
29+
## Before a call starts
3030

31-
`OutgoingAudioFilters` can be applied when a call starts.
31+
You can apply `OutgoingAudioFilters` when a call starts.
3232

33-
Begin by creating a `OutgoingAudioFilters` and passing it into OutgoingAudioOptions as shown in the following code:
33+
Begin by creating an `OutgoingAudioFilters` property and passing it into `OutgoingAudioOptions`, as shown in the following code:
3434

3535
```java
3636
OutgoingAudioOptions outgoingAudioOptions = new OutgoingAudioOptions();
@@ -47,7 +47,7 @@ outgoingAudioOptions.setAudioFilters(filters);
4747

4848
You can apply `LiveOutgoingAudioFilters` after a call begins. You can retrieve this object from the call object during the call. To change the setting in `LiveOutgoingAudioFilters`, set the members inside the class to a valid value and they're applied.
4949

50-
Only a subset of the filters available from `OutgoingAudioFilters` are available during an active call: music mode, echo cancellation, and noise suppression mode.
50+
Only a subset of the filters available from `OutgoingAudioFilters` are available during an active call. They're music mode, echo cancellation, and noise suppression mode.
5151

5252
```java
5353
LiveOutgoingAudioFilters filters = call.getLiveOutgoingAudioFilters();

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Tutorial - Add audio effects suppression ability to your iOS apps
2+
title: 'Tutorial: Add audio effects suppression ability to your iOS apps'
33
titleSuffix: An Azure Communication Services tutorial on how to enable audio effects
4-
description: Learn how to add audio effects in your calls using Azure Communication Services.
4+
description: Learn how to add audio effects in your calls by using Azure Communication Services.
55
author: zehangzheng
66

77
services: azure-communication-services
@@ -16,19 +16,19 @@ ms.subservice: calling
1616

1717
[!INCLUDE [Install SDK](../../../how-tos/calling-sdk/includes/install-sdk/install-sdk-ios.md)]
1818

19-
The audio filter feature enables you to apply different audio preprocessing options to outgoing audio. There are two types of audio filters: `OutgoingAudioFilters` and `LiveOutgoingAudioFilters`. Use `OutgoingAudioFilters` to change settings before the call starts and `LiveOutgoingAudioFilters` to change settings while a call is in progress.
19+
You can use the audio filter feature to apply different audio preprocessing options to outgoing audio. The two types of audio filters are `OutgoingAudioFilters` and `LiveOutgoingAudioFilters`. Use `OutgoingAudioFilters` to change settings before the call starts. Use `LiveOutgoingAudioFilters` to change settings while a call is in progress.
2020

2121
You first need to import the Calling SDK:
2222

2323
```swift
2424
import AzureCommunicationCalling
2525
```
2626

27-
## Before call starts
27+
## Before the call starts
2828

29-
`OutgoingAudioFilters` can be applied when a call starts.
29+
You can apply `OutgoingAudioFilters` when a call starts.
3030

31-
Begin by creating a `OutgoingAudioFilters` and passing it into OutgoingAudioOptions as shown in the following code:
31+
Begin by creating an `OutgoingAudioFilters` property and passing it into `OutgoingAudioOptions`, as shown here:
3232

3333
```swift
3434
let outgoingAudioOptions = OutgoingAudioOptions()
@@ -45,7 +45,7 @@ outgoingAudioOptions.audioFilters = filters
4545

4646
You can apply `LiveOutgoingAudioFilters` after a call begins. You can retrieve this object from the call object during the call. To change the setting in `LiveOutgoingAudioFilters`, set the members inside the class to a valid value and they're applied.
4747

48-
Only a subset of the filters available from `OutgoingAudioFilters` are available during an active call: music mode, echo cancellation, and noise suppression mode.
48+
Only a subset of the filters available from `OutgoingAudioFilters` are available during an active call. They're music mode, echo cancellation, and noise suppression mode.
4949

5050
```swift
5151
LiveOutgoingAudioFilters filters = call.liveOutgoingAudioFilters

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,36 @@ ms.date: 04/30/2024
66
ms.author: jorgarcia
77
---
88

9-
## Learn how to configure the audio filters with the Calling Native SDKs.
9+
## Learn how to configure audio filters with the Native Calling SDKs
1010

11-
The Azure Communication Services audio effects offer filters that can improve your audio call. For native platforms (Android, iOS & Windows) you can configure the following filters:
11+
The Azure Communication Services audio effects offer filters that can improve your audio call. For native platforms (Android, iOS, and Windows), you can configure the following filters.
1212

1313
### Echo cancellation
1414

15-
It eliminates acoustic echo caused by the caller's voice echoing back into the microphone after being emitted from the speaker, ensuring clear communication.
15+
You can eliminate acoustic echo caused by the caller's voice echoing back into the microphone after it's emitted from the speaker. Echo cancellation ensures clear communication.
1616

17-
You can configure the filter before and during a call. You can only toggle echo cancellation only if music mode is enabled. By default, this filter is **enabled**.
17+
You can configure the filter before and during a call. You can toggle echo cancellation only if music mode is enabled. By default, this filter is enabled.
1818

1919
### Noise suppression
2020

21-
Improve the audio quality filtering out unwanted background noises such as typing, air conditioning, or street sounds. This technology ensures that the voice is crisp and clear, facilitating more effective communication.
21+
You can improve audio quality by filtering out unwanted background noises such as typing, air conditioning, or street sounds. This technology ensures that the voice is crisp and clear to facilitate more effective communication.
2222

23-
You can configure the filter before and during a call. The currently available modes are `Off`, `Auto`, `Low`, and `High`. By default, this feature is set to **`High` mode**.
23+
You can configure the filter before and during a call. The currently available modes are **Off**, **Auto**, **Low**, and **High**. By default, this feature is set to **High**.
2424

25-
### Automatic gain control (AGC)
25+
### Automatic gain control
2626

27-
Automatically adjusts the microphone's volume to ensure consistent audio levels throughout the call.
27+
You can automatically adjust the microphone's volume to ensure consistent audio levels throughout the call.
2828

29-
- Analog automatic gain control is a filter only available before a call. By default, this filter is **enabled**.
30-
- Digital automatic gain control is a filter only available before a call. By default, this filter is **enabled**.
29+
- Analog automatic gain control is a filter that's available only before a call. By default, this filter is enabled.
30+
- Digital automatic gain control is a filter that's available only before a call. By default, this filter is enabled.
3131

32-
### Music Mode
32+
### Music mode
3333

34-
Music mode is a filter available before and during a call. Learn more about music mode [here](../../../concepts/voice-video-calling/music-mode.md). Music mode only works on native platforms over 1n1 or group calls and doesn't work in 1:1 calls between native and web. By default, music mode is **disabled**.
34+
Music mode is a filter that's available before and during a call. To learn more about music mode, see [Music mode on Native Calling SDK](../../../concepts/voice-video-calling/music-mode.md). Music mode works only on native platforms over one-on-one or group calls. It doesn't work in one-to-one calls between native platforms and the web. By default, music mode is disabled.
3535

3636
## Prerequisites
3737

38-
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F)
39-
- A deployed Communication Services resource. [Create a Communication Services resource](../../../quickstarts/create-communication-resource.md)
38+
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
39+
- A deployed Azure Communication Services resource. [Create an Azure Communication Services resource](../../../quickstarts/create-communication-resource.md).
4040
- A user access token to enable the calling client. For more information, see [Create and manage access tokens](../../../quickstarts/identity/access-tokens.md).
41-
- Optional: Complete the quickstart to [add voice calling to your application](../../../quickstarts/voice-video-calling/getting-started-with-calling.md)
41+
- Optional: Complete the quickstart to [add voice calling to your application](../../../quickstarts/voice-video-calling/getting-started-with-calling.md).

0 commit comments

Comments
 (0)