Skip to content

FCE-2316 Document noise cancellation and auto gain#270

Open
roznawsk wants to merge 2 commits into
mainfrom
fce-2316
Open

FCE-2316 Document noise cancellation and auto gain#270
roznawsk wants to merge 2 commits into
mainfrom
fce-2316

Conversation

@roznawsk

Copy link
Copy Markdown
Member

What

Documents the audio-processing constraints (echo cancellation, noise suppression / noise cancellation, and auto gain control) for the web client SDK — closes FCE-2316.

Adds an Audio processing: noise cancellation and auto gain section to docs/how-to/client/managing-devices.mdx (Web/Mobile tabs):

  • Explains they are enabled by default and when to disable them (raw audio: music, instruments, custom processing).
  • Web: how to set them explicitly via the constraints prop on FishjamProvider, with enable + raw-audio examples; notes selectMicrophone/startMicrophone reuse the provider constraints.
  • Mobile: enabled by default in the native pipeline, not currently configurable from JS.

Note on the issue premise

FCE-2316 said "we disable them by default", but main of web-client-sdk never sets these constraints (passes audio: true → browser defaults, which are on), and mobile-client-sdk hardcodes them to true natively. So the docs describe the actual behavior (enabled by default) rather than the issue's wording.

Verification

  • cspell: clean
  • Internal cross-link FishjamProviderProps#constraints resolves

@linear

linear Bot commented Jun 25, 2026

Copy link
Copy Markdown

FCE-2316

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documents how built-in audio processing (echo cancellation, noise suppression, auto gain control) behaves and how to configure it for the client SDK device-management guide, clarifying defaults and when to prefer raw audio.

Changes:

  • Adds a new “Audio processing” section describing defaults and tradeoffs for speech vs. raw audio capture.
  • Provides Web-specific examples for setting FishjamProvider constraints, plus a note about how selectMicrophone/startMicrophone relate to provider constraints.
  • Documents Mobile behavior as enabled-by-default in the native pipeline and not currently configurable from JS.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/how-to/client/managing-devices.mdx Outdated
Comment thread docs/how-to/client/managing-devices.mdx
Comment thread docs/how-to/client/managing-devices.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants