Skip to content

Commit e2b5c5e

Browse files
garchiro7garchiro7
committed
Update docs and add music mode file
1 parent 869e1c3 commit e2b5c5e

File tree

6 files changed

+67
-17
lines changed

6 files changed

+67
-17
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.

‎articles/communication-services/concepts/voice-video-calling/music-mode.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
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: t-leejiyoon
6+
ms.author: zehangzheng
7+
ms.service: azure-communication-services
8+
ms.subservice: calling
9+
ms.topic: how-to
10+
ms.date: 07/27/2023
11+
ms.custom: template-how-to
12+
zone_pivot_groups: acs-plat-ios-android-windows
13+
---
14+
15+
# Music Mode
16+
17+
[!INCLUDE [Public Preview Disclaimer](../../includes/public-preview-include-document.md)]
18+
19+
20+
This option enables high-fidelity audio transmission and 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. This enhancement is designed to elevate the audio quality for calls, ensuring that audio is crispy, offering a richer and more immersive audio experience. Once music mode is enabled, you should consider:
21+
22+
- Input and output audio devices that allow high bitrate and sampling rate (two channels, 32 kHz or higher)
23+
- Enable Control Noise suppression
24+
25+
**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.
26+
27+
Calling Native SDK provides an additional set of audio filters that will bring a richer experience during the call.
28+
29+
### Analog Automatic gain control
30+
31+
Analog automatic gain control is a filter available before a call.
32+
33+
### Digital Automatic gain control
34+
35+
Digital automatic gain control is a filter available before a call.
36+
37+
### Echo cancellation
38+
39+
Echo cancellation is a filter available before and during a call. You can only toggle echo cancellation only if music mode is enabled.
40+
41+
### Noise suppression
42+
43+
Noise suppression is a filter available before and during a call. The currently available modes are `Off`, `Auto`, `Low`, and `High`.
44+
45+
## Next steps
46+
- [Learn how to setup adio 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: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ 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

1212
You first need import the Calling SDK and the associated classes:
1313

@@ -17,7 +17,8 @@ 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.

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

Lines changed: 5 additions & 3 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

1212
You first need 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.

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ 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

1212
You first need import the Calling SDK:
1313

@@ -16,8 +16,9 @@ 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.

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

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ 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. You 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.
2020

2121
Currently, there are five different filters available to control.
2222

@@ -30,12 +30,7 @@ Digital automatic gain control is a filter available before a call. By default,
3030

3131
## Music Mode
3232

33-
This option enables high-fidelity audio transmission and 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. This enhancement is designed to elevate the audio quality for calls, ensuring that audio is crispy, offering a richer and more immersive audio experience. Once music mode is enabled, you should consider:
34-
35-
- Input and output audio devices that allow high bitrate and sampling rate (two channels, 32 kHz or higher)
36-
- Enable Control Noise suppression
37-
38-
**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.
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.
3934

4035
## Echo cancellation
4136

@@ -65,6 +60,7 @@ Noise suppression is a filter available before and during a call. The currently
6560
::: zone-end
6661

6762
## Next steps
63+
6864
- [Learn how to manage calls](./manage-calls.md)
6965
- [Learn how to record calls](./record-calls.md)
7066
- [Learn how to transcribe calls](./call-transcription.md)

0 commit comments

Comments
 (0)