-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add docs about noise cancellation and update settings table
- Loading branch information
Showing
4 changed files
with
36 additions
and
1 deletion.
There are no files selected for viewing
27 changes: 27 additions & 0 deletions
27
docusaurus/video/docusaurus/docs/api/call_types/noise-cancellation.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
id: noise-cancellation | ||
sidebar_position: 5 | ||
slug: /call_types/noise_cancellation | ||
title: Noise Cancellation | ||
--- | ||
|
||
Noise cancellation is a feature that removes background noise from a call. This feature is useful when you are in a noisy environment and want to improve the call quality. | ||
Stream video SDKs come with built-in noise cancellation, which you can enable or disable as needed. | ||
|
||
Note: noise cancellation is performed on the device that captures the audio and not by Stream servers. | ||
|
||
The built-in noise cancellation is optimized for voice calls and is not suitable for capturing music or other audio. You can configure noise cancellation for your call types in three ways: | ||
|
||
- `available` noise cancellation can be enabled by users via SDK but it starts disabled | ||
- `disabled` noise cancellation is not available for users to enable (do this if you want to ensure noise cancellation is never used) | ||
- `auto-on` noise cancellation is always enabled for all calls, users can still disabled it manually via SDK | ||
|
||
### Best practices | ||
|
||
1. Use noise cancellation to improve call quality, especially in noisy environments | ||
2. Do not use noise cancellation if you want to capture music or other audio | ||
3. Noise cancellation is charged per minute, if you dont need it, disable it to save costs | ||
|
||
### Custom noise cancellation | ||
|
||
All SDKs come with support for custom audio and video filters. If needed, you can bring your own noise cancellation filter instead of using the built-in noise cancellation. SDK docs have more information on how to do this. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters