Skip to content

Commit b05ad3a

Browse files
Merge pull request #267878 from garchiro7/main
Add music mode documentation.
2 parents 7c395cc + c3da0f6 commit b05ad3a

File tree

7 files changed

+92
-78
lines changed

7 files changed

+92
-78
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ The following list presents the set of features that are currently available in
9797
| | Render remote video stream | ✔️ | ✔️ | ✔️ | ✔️ |
9898
| Video Effects | [Background Blur](../../quickstarts/voice-video-calling/get-started-video-effects.md) | ✔️ | ✔️ | ✔️ | ✔️ |
9999
| | Custom background image | ✔️ ||||
100+
| Audio Effects | [Music Mode](./music-mode.md) || ✔️ | ✔️ | ✔️ |
101+
| | [Audio filters](../../how-tos/calling-sdk/manage-audio-filters.md) || ✔️ | ✔️ | ✔️ |
100102

101103

102104
<sup>1</sup> The capability to Mute Others is currently in public preview.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Music Mode on Native Calling SDK
3+
titleSuffix: An Azure Communication Services Calling concept doc
4+
description: Use Azure Communication Services Calling to review Music Mode.
5+
author: garchiro7
6+
ms.author: jorgegarc
7+
ms.service: azure-communication-services
8+
ms.subservice: calling
9+
ms.topic: how-to
10+
ms.date: 03/01/2024
11+
ms.custom: template-how-to
12+
---
13+
14+
# Music Mode
15+
16+
[!INCLUDE [Public Preview Disclaimer](../../includes/public-preview-include-document.md)]
17+
18+
The **music mode** enhances the audio quality for music playback and performance within virtual environments, ensuring clarity and depth in sound reproduction; currently supports a 32-kHz sampling rate at 128 kbps when network bandwidth allows; when network bandwidth is insufficient, the bitrate can be reduced to as low as 48 kbps.
19+
20+
This feature is designed to elevate the audio quality for calls, ensuring the audio is crispy and offering a richer and more immersive audio experience. Also, it reduces audio compression to maintain the original sound, making it ideal for applications ranging from live musical performances and remote music education or music sessions.
21+
22+
Once music mode is enabled, you should consider:
23+
24+
- Input and output audio devices that allow high bitrate and sampling rate (two channels, 32 kHz or higher)
25+
- Enable Control Noise suppression
26+
27+
We recommend using high-quality external loudspeakers, professional microphones, or headsets instead of Bluetooth devices to optimize the music mode.
28+
29+
**Note:** music mode only works in 1:1 calls on native platforms and group calls. Currently, music mode doesn't work in 1:1 calls between native and web. By default, music mode is disabled.
30+
31+
The Calling native SDK provides an additional set of audio filters that bring a richer experience during the call:
32+
33+
- Analog Automatic gain control
34+
- Digital Automatic gain control
35+
- Echo cancellation. *You can only toggle echo cancellation only if music mode is enabled*
36+
- Noise suppression. *The currently available modes are `Off`, `Auto`, `Low`, and `High`*
37+
38+
## Next steps
39+
- [Learn how to setup audio filters](../../how-tos/calling-sdk/manage-audio-filters.md)

articles/communication-services/how-tos/calling-sdk/includes/manage-audio-filters/manage-audio-filters-android.md

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,18 @@ ms.author: zehangzheng
77
---
88
[!INCLUDE [Install SDK](../install-sdk/install-sdk-android.md)]
99

10-
The audio filter feature allows different audio preprocessing options to be applied to outgoing audio. There are two types of audio filters: OutgoingAudioFilters and LiveOutgoingAudioFilters, with OutgoingAudioFilters changing settings before the call starts and LiveOutgoingAudioFilters changing settings while a call is in progress.
10+
The audio filter feature allows different audio preprocessing options to be applied to outgoing audio. There are two types of audio filters: `OutgoingAudioFilters` and `LiveOutgoingAudioFilters`, with `OutgoingAudioFilters` changing settings before the call starts and `LiveOutgoingAudioFilters` changing settings while a call is in progress.
1111

12-
You first need import the Calling SDK and the associated classes:
12+
You first need to import the Calling SDK and the associated classes:
1313

1414
```csharp
1515
import com.azure.android.communication.calling.OutgoingAudioOptions;
1616
import com.azure.android.communication.calling.OutgoingAudioFilters;
1717
import com.azure.android.communication.calling.LiveOutgoingAudioFilters;
1818
```
1919

20-
## OutgoingAudioFilters
20+
## Before call starts
21+
2122
`OutgoingAudioFilters` can be applied when a call starts.
2223

2324
Begin by creating a `OutgoingAudioFilters` and passing it into OutgoingAudioOptions as shown in the following code:
@@ -33,7 +34,8 @@ filters.setAcousticEchoCancellationEnabled(true);
3334
outgoingAudioOptions.setAudioFilters(filters);
3435
```
3536

36-
## LiveOutgoingAudioFilters
37+
## During the call
38+
3739
`LiveOutgoingAudioFilters` can be applied after a call has started. You can retrieve this object from the call object once the call has started. To change the setting in `LiveOutgoingAudioFilters`, set the members inside the class to a valid value and they're applied.
3840

3941
Only a subset of the filters available from `OutgoingAudioFilters` are available during an active call: music mode, echo cancellation, and noise suppression mode.
@@ -44,23 +46,3 @@ filters.setMusicModeEnabled(false);
4446
filters.setAcousticEchoCancellationEnabled(false);
4547
filters.setNoiseSuppressionMode(NoiseSuppressionMode.HIGH);
4648
```
47-
48-
## Available Filters
49-
50-
Currently, there are five different filters available to control.
51-
52-
### Analog Automatic gain control
53-
Analog automatic gain control is a filter available before a call. By default, this filter is enabled.
54-
55-
### Digital Automatic gain control
56-
Digital automatic gain control is a filter available before a call. By default, this filter is enabled.
57-
58-
### Music Mode
59-
Music mode is a filter available before and during a call. Learn more about music mode [here](https://support.microsoft.com/office/use-high-fidelity-music-mode-to-play-music-in-microsoft-teams-c1550582-2f76-4b31-9f72-e98c7167a18e). Note that music mode only works in 1:1 calls on native platforms and group calls. Currently, music mode doesn't work in 1:1 calls between native and web. By default, music mode is disabled.
60-
61-
62-
### Echo cancellation
63-
Echo cancellation is a filter available before and during a call. You can only toggle echo cancellation only if music mode is enabled. By default, this filter is enabled.
64-
65-
### Noise suppression
66-
Noise suppression is a filter available before and during a call. The currently available modes are `Off`, `Auto`, `Low`, and `High`. By default, this feature is set to `High` mode.

articles/communication-services/how-tos/calling-sdk/includes/manage-audio-filters/manage-audio-filters-ios.md

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,16 @@ ms.author: zehangzheng
77
---
88
[!INCLUDE [Install SDK](../install-sdk/install-sdk-ios.md)]
99

10-
The audio filter feature allows different audio preprocessing options to be applied to outgoing audio. There are two types of audio filters: OutgoingAudioFilters and LiveOutgoingAudioFilters, with OutgoingAudioFilters changing settings before the call starts and LiveOutgoingAudioFilters changing settings while a call is in progress.
10+
The audio filter feature allows different audio preprocessing options to be applied to outgoing audio. There are two types of audio filters: `OutgoingAudioFilters` and `LiveOutgoingAudioFilters`, with `OutgoingAudioFilters` changing settings before the call starts and `LiveOutgoingAudioFilters` changing settings while a call is in progress.
1111

12-
You first need import the Calling SDK:
12+
You first need to import the Calling SDK:
1313

1414
```swift
1515
import AzureCommunicationCalling
1616
```
1717

18-
## OutgoingAudioFilters
18+
## Before call starts
19+
1920
`OutgoingAudioFilters` can be applied when a call starts.
2021

2122
Begin by creating a `OutgoingAudioFilters` and passing it into OutgoingAudioOptions as shown in the following code:
@@ -31,7 +32,8 @@ filters.acousticEchoCancellationEnabled = true
3132
outgoingAudioOptions.audioFilters = filters
3233
```
3334

34-
## LiveOutgoingAudioFilters
35+
## During the call
36+
3537
`LiveOutgoingAudioFilters` can be applied after a call has started. You can retrieve this object from the call object once the call has started. To change the setting in `LiveOutgoingAudioFilters`, set the members inside the class to a valid value and they're applied.
3638

3739
Only a subset of the filters available from `OutgoingAudioFilters` are available during an active call: music mode, echo cancellation, and noise suppression mode.
@@ -42,23 +44,3 @@ filters.musicModeEnabled = true
4244
filters.acousticEchoCancellationEnabled = true
4345
filters.NoiseSuppressionMode = NoiseSuppressionMode.high
4446
```
45-
46-
## Available Filters
47-
48-
Currently, there are five different filters available to control.
49-
50-
### Analog Automatic gain control
51-
Analog automatic gain control is a filter available before a call. By default, this filter is enabled.
52-
53-
### Digital Automatic gain control
54-
Digital automatic gain control is a filter available before a call. By default, this filter is enabled.
55-
56-
### Music Mode
57-
Music mode is a filter available before and during a call. Learn more about music mode [here](https://support.microsoft.com/office/use-high-fidelity-music-mode-to-play-music-in-microsoft-teams-c1550582-2f76-4b31-9f72-e98c7167a18e). Note that music mode only works in 1:1 calls on native platforms and group calls. Currently, music mode doesn't work in 1:1 calls between native and web. By default, music mode is disabled.
58-
59-
60-
### Echo cancellation
61-
Echo cancellation is a filter available before and during a call. You can only toggle echo cancellation only if music mode is enabled. By default, this filter is enabled.
62-
63-
### Noise suppression
64-
Noise suppression is a filter available before and during a call. The currently available modes are `Off`, `Auto`, `Low`, and `High`. By default, this feature is set to `High` mode.

articles/communication-services/how-tos/calling-sdk/includes/manage-audio-filters/manage-audio-filters-windows.md

Lines changed: 7 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,18 @@ ms.author: t-leejiyoon
77
---
88
[!INCLUDE [Install SDK](../install-sdk/install-sdk-windows.md)]
99

10-
The audio filter feature allows different audio preprocessing options to be applied to outgoing audio. There are two types of audio filters: OutgoingAudioFilters and LiveOutgoingAudioFilters, with OutgoingAudioFilters changing settings before the call starts and LiveOutgoingAudioFilters changing settings while a call is in progress.
10+
The audio filter feature allows different audio preprocessing options to be applied to outgoing audio. There are two types of audio filters: `OutgoingAudioFilters` and `LiveOutgoingAudioFilters`, with `OutgoingAudioFilters` changing settings before the call starts and `LiveOutgoingAudioFilters` changing settings while a call is in progress.
1111

12-
You first need import the Calling SDK:
12+
You first need to import the Calling SDK:
1313

1414
```csharp
1515
using Azure.Communication;
1616
using Azure.Communication.Calling.WindowsClient;
1717
```
1818

19-
## OutgoingAudioFilters
20-
`OutgoingAudioFilters` can be applied when a call starts.
19+
## Before call starts
20+
21+
`OutgoingAudioFilters` can be applied when a call starts.
2122

2223
Begin by creating a `OutgoingAudioFilters` and passing it into OutgoingAudioOptions as shown in the following code:
2324

@@ -34,7 +35,8 @@ var filters = new OutgoingAudioFilters()
3435
outgoingAudioOptions.Filters = filters;
3536
```
3637

37-
## LiveOutgoingAudioFilters
38+
## During the call
39+
3840
`LiveOutgoingAudioFilters` can be applied after a call has started. You can retrieve this object from the call object once the call has started. To change the setting in `LiveOutgoingAudioFilters`, set the members inside the class to a valid value and they're applied.
3941

4042
Only a subset of the filters available from `OutgoingAudioFilters` are available during an active call: music mode, echo cancellation, and noise suppression mode.
@@ -45,23 +47,3 @@ filter.MusicModeEnabled = true;
4547
filter.AcousticEchoCancellationEnabled = true;
4648
filter.NoiseSuppressionMode = NoiseSuppressionMode.Auto;
4749
```
48-
49-
## Available Filters
50-
51-
Currently, there are five different filters available to control.
52-
53-
### Analog Automatic gain control
54-
Analog automatic gain control is a filter available before a call. By default, this filter is enabled.
55-
56-
### Digital Automatic gain control
57-
Digital automatic gain control is a filter available before a call. By default, this filter is enabled.
58-
59-
### Music Mode
60-
Music mode is a filter available before and during a call. Learn more about music mode [here](https://support.microsoft.com/office/use-high-fidelity-music-mode-to-play-music-in-microsoft-teams-c1550582-2f76-4b31-9f72-e98c7167a18e). Note that music mode only works in 1:1 calls on native platforms and group calls. Currently, music mode doesn't work in 1:1 calls between native and web. By default, music mode is disabled.
61-
62-
63-
### Echo cancellation
64-
Echo cancellation is a filter available before and during a call. You can only toggle echo cancellation only if music mode is enabled. By default, this filter is enabled.
65-
66-
### Noise suppression
67-
Noise suppression is a filter available before and during a call. The currently available modes are `Off`, `Auto`, `Low`, and `High`. By default, this feature is set to `High` mode.

articles/communication-services/how-tos/calling-sdk/manage-audio-filters.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Outgoing Audio Filters
2+
title: Manage the audio filters on Calling Native SDKs
33
titleSuffix: An Azure Communication Services how-to guide
4-
description: Use Azure Communication Services SDKs to set outgoing audio filters.
4+
description: Use Azure Communication Services Calling SDKs to set the audio filters.
55
author: t-leejiyoon
66
ms.author: zehangzheng
77
ms.service: azure-communication-services
@@ -16,12 +16,34 @@ zone_pivot_groups: acs-plat-ios-android-windows
1616

1717
[!INCLUDE [Public Preview Disclaimer](../../includes/public-preview-include-document.md)]
1818

19-
Learn how to manage audio processing features with the Azure Communication Services SDKS. We'll learn how to apply different audio features before and during calls using audio filters.
19+
Learn how to manage audio processing features with the Azure Communication Services SDKS. You learn how to apply different audio features before and during calls using audio filters.
20+
21+
Currently, there are five different filters available to control.
22+
23+
## Analog Automatic gain control
24+
25+
Analog automatic gain control is a filter available before a call. By default, this filter is enabled.
26+
27+
## Digital Automatic gain control
28+
29+
Digital automatic gain control is a filter available before a call. By default, this filter is enabled.
30+
31+
## Music Mode
32+
33+
Music mode is a filter available before and during a call. Learn more about music mode [here](../../concepts/voice-video-calling/music-mode.md). Note that music mode only works in 1:1 calls on native platforms and group calls. Currently, music mode doesn't work in 1:1 calls between native and web. By default, music mode is disabled.
34+
35+
## Echo cancellation
36+
37+
Echo cancellation is a filter available before and during a call. You can only toggle echo cancellation only if music mode is enabled. By default, this filter is enabled.
38+
39+
## Noise suppression
40+
41+
Noise suppression is a filter available before and during a call. The currently available modes are `Off`, `Auto`, `Low`, and `High`. By default, this feature is set to `High` mode.
2042

2143
## Prerequisites
2244

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

@@ -38,6 +60,7 @@ Learn how to manage audio processing features with the Azure Communication Servi
3860
::: zone-end
3961

4062
## Next steps
63+
4164
- [Learn how to manage calls](./manage-calls.md)
4265
- [Learn how to record calls](./record-calls.md)
4366
- [Learn how to transcribe calls](./call-transcription.md)

articles/communication-services/toc.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -725,6 +725,10 @@ items:
725725
- name: Video constraints
726726
href: concepts/voice-video-calling/video-constraints.md
727727
displayName: diagnostics, diagnose, feedback, quality, reliability, users, call, quick, satisfaction, improve, issues
728+
- name: Music mode
729+
href: concepts/voice-video-calling/music-mode.md
730+
displayName: music mode, audio filters, calling
731+
728732
- name: Simulcast
729733
href: concepts/voice-video-calling/simulcast.md
730734
displayName: diagnostics, diagnose, feedback, quality, reliability, users, call, quick, satisfaction, improve, issues

0 commit comments

Comments
 (0)