Conversation
Contributor
There was a problem hiding this comment.
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
FishjamProviderconstraints, plus a note about howselectMicrophone/startMicrophonerelate 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.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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):constraintsprop onFishjamProvider, with enable + raw-audio examples; notesselectMicrophone/startMicrophonereuse the provider constraints.Note on the issue premise
FCE-2316 said "we disable them by default", but
mainof web-client-sdk never sets these constraints (passesaudio: true→ browser defaults, which are on), and mobile-client-sdk hardcodes them totruenatively. So the docs describe the actual behavior (enabled by default) rather than the issue's wording.Verification
FishjamProviderProps#constraintsresolves