From aafe089e5a715956b7ed6462ecdffdd7f9be89a0 Mon Sep 17 00:00:00 2001 From: Tommaso Barbugli Date: Tue, 5 Nov 2024 13:55:05 +0100 Subject: [PATCH] add docs about noise cancellation and update settings table --- .../api/call_types/noise-cancellation.mdx | 27 +++++++++++++++++++ .../docs/api/call_types/settings.mdx | 2 +- .../docs/api/recording/recording_calls.mdx | 4 +++ .../api/transcription/transcribing_calls.mdx | 4 +++ 4 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 docusaurus/video/docusaurus/docs/api/call_types/noise-cancellation.mdx diff --git a/docusaurus/video/docusaurus/docs/api/call_types/noise-cancellation.mdx b/docusaurus/video/docusaurus/docs/api/call_types/noise-cancellation.mdx new file mode 100644 index 00000000..49570386 --- /dev/null +++ b/docusaurus/video/docusaurus/docs/api/call_types/noise-cancellation.mdx @@ -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. diff --git a/docusaurus/video/docusaurus/docs/api/call_types/settings.mdx b/docusaurus/video/docusaurus/docs/api/call_types/settings.mdx index 9fb591b5..00118be8 100644 --- a/docusaurus/video/docusaurus/docs/api/call_types/settings.mdx +++ b/docusaurus/video/docusaurus/docs/api/call_types/settings.mdx @@ -1,6 +1,6 @@ --- id: call_types_settings -sidebar_position: 5 +sidebar_position: 6 slug: /call_types/settings title: Settings --- diff --git a/docusaurus/video/docusaurus/docs/api/recording/recording_calls.mdx b/docusaurus/video/docusaurus/docs/api/recording/recording_calls.mdx index 023698b5..c4ad5798 100644 --- a/docusaurus/video/docusaurus/docs/api/recording/recording_calls.mdx +++ b/docusaurus/video/docusaurus/docs/api/recording/recording_calls.mdx @@ -1000,3 +1000,7 @@ curl -X PUT "https://video.stream-io-api.com/api/v2/video/calltypes/${CALL_TYPE_ ## Client-side recording Unfortunately, there is no direct support for client-side recording at the moment. Call recording at the moment is done by Stream server-side. If client-side recording is important for you please make sure to follow the conversation [here](https://github.com/GetStream/protocol/discussions/249). + +## Noise Cancellation + +Enabling noise cancellation can help to improve the quality of the recorded audio. This feature is available for all calls and can be enabled from the dashboard or via the API. diff --git a/docusaurus/video/docusaurus/docs/api/transcription/transcribing_calls.mdx b/docusaurus/video/docusaurus/docs/api/transcription/transcribing_calls.mdx index 5190ce07..b91563a8 100644 --- a/docusaurus/video/docusaurus/docs/api/transcription/transcribing_calls.mdx +++ b/docusaurus/video/docusaurus/docs/api/transcription/transcribing_calls.mdx @@ -567,3 +567,7 @@ curl -X POST "https://video.stream-io-api.com/api/v2/video/call/default/${CALL_I - Malay (ms) - Norwegian (no) - Ukrainian (uk) + +## Noise Cancellation + +Enabling noise cancellation can help to improve the quality of transcriptions and closed captions. It is recommended to enable noise cancellation when transcribing calls with background noise.