Skip to content

Commit

Permalink
Updates (#1192)
Browse files Browse the repository at this point in the history
  • Loading branch information
saudsami authored Sep 1, 2024
1 parent 1e976a9 commit 746fd62
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 30 deletions.
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<PlatformWrapper platform="android">

### Disable `3A`
### Disable 3A

<Vg k="VSDK" /> turns on `3A` by default. `3A` stands for echo cancellation (AEC), noise reduction (ANS), and gain control (AGC) in audio processing. Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if `3A` is enabled in the application layer, it may cause over-processing of the audio signal, and interference between different algorithms may impact sound quality. Therefore, it is recommended that users using sound cards call [`setParameters`](https://api-ref.agora.io/en/voice-sdk/android/4.x/API/class_irtcengine.html#api_irtcengine_setparameters) to disable the `3A` function enabled by default.
<Vg k="VSDK" /> turns on 3A by default. In audio processing, 3A stands for Acoustic Echo Cancellation (AEC), Active Noise Suppression (ANS), and Automatic Gain Control (AGC). Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if 3A is enabled in the application layer, it may cause over-processing of the audio signal and interference between different algorithms may impact sound quality. Best practice is that users with sound cards disable the 3A function by calling [`setParameters`](https://api-ref.agora.io/en/voice-sdk/android/4.x/API/class_irtcengine.html#api_irtcengine_setparameters).

```java
setParameters("{\"che.audio.aec.enable\":false}"), // Turn off echo cancellation
setParameters("{\"che.audio.ans.enable\":false}"), // Turn off noise reduction
setParameters("{\"che.audio.agc.enable\":false}"), // Turn off gain control
setParameters("{\"che.audio.aec.enable\":false}") // Turn off echo cancellation
setParameters("{\"che.audio.ans.enable\":false}") // Turn off noise reduction
setParameters("{\"che.audio.agc.enable\":false}") // Turn off gain control
```

### Turn on stereo capture
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<PlatformWrapper platform="electron">

### Disable `3A`
### Disable 3A

<Vg k="VSDK" /> turns on `3A` by default. `3A` stands for echo cancellation (AEC), noise reduction (ANS, and gain control (AGC) in audio processing. Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if `3A` is enabled in the application layer, it may cause over-processing of the audio signal, and interference between different algorithms may impact sound quality. Therefore, it is recommended that users using sound cards call [`setParameters`](https://api-ref.agora.io/en/video-sdk/electron/4.x/API/class_irtcengine.html#api_irtcengine_setparameters) to disable the `3A` function enabled by default.
<Vg k="VSDK" /> turns on 3A by default. In audio processing, 3A stands for Acoustic Echo Cancellation (AEC), Active Noise Suppression (ANS), and Automatic Gain Control (AGC). Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if 3A is enabled in the application layer, it may cause over-processing of the audio signal and interference between different algorithms may impact sound quality. Best practice is that users with sound cards disable the 3A function by calling [`setParameters`](https://api-ref.agora.io/en/video-sdk/electron/4.x/API/class_irtcengine.html#api_irtcengine_setparameters).

```typescript
abstract setParameters(parameters: string): number;
setParameters("{\"che.audio.aec.enable\":false}") // Turn off echo cancellation
setParameters("{\"che.audio.ans.enable\":false}") // Turn off noise reduction
setParameters("{\"che.audio.agc.enable\":false}") // Turn off gain control
```

### Turn on stereo capture
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<PlatformWrapper platform="flutter">

### Disable `3A`
### Disable 3A

<Vg k="VSDK" /> turns on `3A` by default. `3A` stands for echo cancellation (AEC), noise reduction (ANS), and gain control (AGC) in audio processing. Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if `3A` is enabled in the application layer, it may cause over-processing of the audio signal, and interference between different algorithms may impact sound quality. Therefore, it is recommended that users using sound cards call [`setParameters`](https://api-ref.agora.io/en/video-sdk/flutter/6.x/API/class_irtcengine.html#api_irtcengine_setparameters) to disable the `3A` function enabled by default.
<Vg k="VSDK" /> turns on 3A by default. In audio processing, 3A stands for Acoustic Echo Cancellation (AEC), Active Noise Suppression (ANS), and Automatic Gain Control (AGC). Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if 3A is enabled in the application layer, it may cause over-processing of the audio signal and interference between different algorithms may impact sound quality. Best practice is that users with sound cards disable the 3A function by calling [`setParameters`](https://api-ref.agora.io/en/video-sdk/flutter/6.x/API/class_irtcengine.html#api_irtcengine_setparameters).

```dart
Future<void> setParameters(String parameters);
setParameters("{\"che.audio.aec.enable\":false}") // Turn off echo cancellation
setParameters("{\"che.audio.ans.enable\":false}") // Turn off noise reduction
setParameters("{\"che.audio.agc.enable\":false}") // Turn off gain control
```

### Turn on stereo capture
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<PlatformWrapper platform="ios">

### Disable `3A`
### Disable 3A

<Vg k="VSDK" /> turns on `3A` by default. `3A` stands for echo cancellation (AEC), noise reduction (ANS), and gain control (AGC) in audio processing. Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if `3A` is enabled in the application layer, it may cause over-processing of the audio signal, and interference between different algorithms may impact sound quality. Therefore, it is recommended that users using sound cards call [`setParameters`](https://api-ref.agora.io/en/video-sdk/ios/4.x/documentation/agorartckit/agorartcenginekit/setparameters(_:)) to disable the `3A` function enabled by default.
<Vg k="VSDK" /> turns on 3A by default. In audio processing, 3A stands for Acoustic Echo Cancellation (AEC), Active Noise Suppression (ANS), and Automatic Gain Control (AGC). Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if 3A is enabled in the application layer, it may cause over-processing of the audio signal and interference between different algorithms may impact sound quality. Best practice is that users with sound cards disable the 3A function by calling [`setParameters`](https://api-ref.agora.io/en/video-sdk/ios/4.x/documentation/agorartckit/agorartcenginekit/setparameters(_:)).

```objc
(int) setParameters : (NSString * _Nonnull) options NS_SWIFT_NAME (setParameters(_ : ));
setParameters("{\"che.audio.aec.enable\":false}") // Turn off echo cancellation
setParameters("{\"che.audio.ans.enable\":false}") // Turn off noise reduction
setParameters("{\"che.audio.agc.enable\":false}") // Turn off gain control
```
### Turn on stereo capture
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<PlatformWrapper platform="macos">

### Disable `3A`
### Disable 3A

<Vg k="VSDK" /> turns on `3A` by default. `3A` stands for echo cancellation (AEC), noise reduction (ANS), and gain control (AGC) in audio processing. Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if `3A` is enabled in the application layer, it may cause over-processing of the audio signal, and interference between different algorithms may impact sound quality. Therefore, it is recommended that users using sound cards call [`setParameters`](https://api-ref.agora.io/en/video-sdk/macos/4.x/documentation/agorartckit/agorartcenginekit/setparameters(_:)) to disable the `3A` function enabled by default.
<Vg k="VSDK" /> turns on 3A by default. In audio processing, 3A stands for Acoustic Echo Cancellation (AEC), Active Noise Suppression (ANS), and Automatic Gain Control (AGC). Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if 3A is enabled in the application layer, it may cause over-processing of the audio signal and interference between different algorithms may impact sound quality. Best practice is that users with sound cards disable the 3A function by calling [`setParameters`](https://api-ref.agora.io/en/video-sdk/macos/4.x/documentation/agorartckit/agorartcenginekit/setparameters(_:)).

```objc
(int) setParameters : (NSString * _Nonnull) options NS_SWIFT_NAME (setParameters(_ : ));
setParameters("{\"che.audio.aec.enable\":false}") // Turn off echo cancellation
setParameters("{\"che.audio.ans.enable\":false}") // Turn off noise reduction
setParameters("{\"che.audio.agc.enable\":false}") // Turn off gain control
```
### Turn on stereo capture
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<PlatformWrapper platform="react-native">

### Disable `3A`
### Disable 3A

<Vg k="VSDK" /> turns on `3A` by default. `3A` stands for echo cancellation (AEC), noise reduction (ANS), and gain control (AGC) in audio processing. Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if `3A` is enabled in the application layer, it may cause over-processing of the audio signal, and interference between different algorithms may impact sound quality. Therefore, it is recommended that users using sound cards call [`setParameters`](https://api-ref.agora.io/en/video-sdk/react-native/4.x/API/class_irtcengine.html#api_irtcengine_setparameters) to disable the `3A` function enabled by default.
<Vg k="VSDK" /> turns on 3A by default. In audio processing, 3A stands for Acoustic Echo Cancellation (AEC), Active Noise Suppression (ANS), and Automatic Gain Control (AGC). Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if 3A is enabled in the application layer, it may cause over-processing of the audio signal and interference between different algorithms may impact sound quality. Best practice is that users with sound cards disable the 3A function by calling [`setParameters`](https://api-ref.agora.io/en/video-sdk/react-native/4.x/API/class_irtcengine.html#api_irtcengine_setparameters).

```typescript
abstract setParameters(parameters: string): number;
setParameters("{\"che.audio.aec.enable\":false}") // Turn off echo cancellation
setParameters("{\"che.audio.ans.enable\":false}") // Turn off noise reduction
setParameters("{\"che.audio.agc.enable\":false}") // Turn off gain control
```

### Turn on stereo capture
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
<PlatformWrapper platform="unity">

### Disable `3A`
### Disable 3A

<Vg k="VSDK" /> turns on `3A` by default. `3A` stands for echo cancellation (AEC), noise reduction (ANS), and gain control (AGC) in audio processing. Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if `3A` is enabled in the application layer, it may cause over-processing of the audio signal, and interference between different algorithms may impact sound quality. Therefore, it is recommended that users using sound cards call [`setParameters`](https://api-ref.agora.io/en/video-sdk/unity/4.x/API/class_irtcengine.html#api_irtcengine_setparameters) to disable the `3A` function enabled by default.
<Vg k="VSDK" /> turns on 3A by default. In audio processing, 3A stands for Acoustic Echo Cancellation (AEC), Active Noise Suppression (ANS), and Automatic Gain Control (AGC). Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if 3A is enabled in the application layer, it may cause over-processing of the audio signal and interference between different algorithms may impact sound quality. Best practice is that users with sound cards disable the 3A function by calling [`SetParameters`](https://api-ref.agora.io/en/video-sdk/unity/4.x/API/class_irtcengine.html#api_irtcengine_setparameters).

```c#
public abstract int SetParameters(string key, object value);
```cpp
SetParameters("{\"che.audio.aec.enable\":false}") // Turn off echo cancellation
SetParameters("{\"che.audio.ans.enable\":false}") // Turn off noise reduction
SetParameters("{\"che.audio.agc.enable\":false}") // Turn off gain control
```
### Turn on stereo capture
Call [`setAdvancedAudioOptions`](https://api-ref.agora.io/en/video-sdk/unity/4.x/API/class_irtcengine.html#api_irtcengine_setadvancedaudiooptions) to set the number of audio pre-processing channels to `AGORA_AUDIO_STEREO_PROCESSING` (2), that is, use two channels to collect and send stereo sound.
Call [`SetAdvancedAudioOptions`](https://api-ref.agora.io/en/video-sdk/unity/4.x/API/class_irtcengine.html#api_irtcengine_setadvancedaudiooptions) to set the number of audio pre-processing channels to `AGORA_AUDIO_STEREO_PROCESSING` (2), that is, use two channels to collect and send stereo sound.
```c#
public abstract int SetAdvancedAudioOptions(AdvancedAudioOptions options);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<PlatformWrapper platform="web">

### Disable `3A`
### Disable 3A

<Vg k="VSDK" /> turns on `3A` by default. `3A` stands for echo cancellation (AEC), noise reduction (ANS), and gain control (AGC) in audio processing. Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if `3A` is enabled in the application layer, it may cause over-processing of the audio signal, and interference between different algorithms may impact sound quality. Therefore, it is recommended that users using sound cards call [`createMicrophoneAudioTrack`](https://api-ref.agora.io/en/video-sdk/web/4.x/interfaces/iagorartc.html#createmicrophoneaudiotrack) to disable the `3A` function enabled by default.
<Vg k="VSDK" /> turns on 3A by default. In audio processing, 3A stands for Acoustic Echo Cancellation (AEC), Active Noise Suppression (ANS), and Automatic Gain Control (AGC). Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if 3A is enabled in the application layer, it may cause over-processing of the audio signal and interference between different algorithms may impact sound quality. Best practice is that users with sound cards disable 3A by calling [`createMicrophoneAudioTrack`](https://api-ref.agora.io/en/video-sdk/web/4.x/interfaces/iagorartc.html#createmicrophoneaudiotrack).

```javascript
AgoraRTC.createMicrophoneAudioTrack({
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<PlatformWrapper platform="windows">

### Disable `3A`
### Disable 3A

<Vg k="VSDK" /> turns on `3A` by default. `3A` stands for echo cancellation (AEC), noise reduction (ANS), and gain control (AGC) in audio processing. Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if `3A` is enabled in the application layer, it may cause over-processing of the audio signal, and interference between different algorithms may impact sound quality. Therefore, it is recommended that users using sound cards call [`setParameters` [1/2]](https://api-ref.agora.io/en/video-sdk/cpp/4.x/API/class_irtcengine.html#api_irtcengine_setparameters) to disable the `3A` function enabled by default.
<Vg k="VSDK" /> turns on 3A by default. In audio processing, 3A stands for Acoustic Echo Cancellation (AEC), Active Noise Suppression (ANS), and Automatic Gain Control (AGC). Sound card devices usually provide some built-in audio processing, such as echo and noise cancellation. Currently, if 3A is enabled in the application layer, it may cause over-processing of the audio signal and interference between different algorithms may impact sound quality. Best practice is that users with sound cards disable the 3A function by calling [`setParameters`](https://api-ref.agora.io/en/video-sdk/cpp/4.x/API/class_irtcengine.html#api_irtcengine_setparameters).

```cpp
virtual int setParameters(const char* parameters) = 0;
setParameters("{\"che.audio.aec.enable\":false}") // Turn off echo cancellation
setParameters("{\"che.audio.ans.enable\":false}") // Turn off noise reduction
setParameters("{\"che.audio.agc.enable\":false}") // Turn off gain control
```
### Turn on stereo capture
Expand Down

0 comments on commit 746fd62

Please sign in to comment.