Conversation
czerwiukk
requested review from
MiloszFilimowski,
PiotrWodecki,
Copilot and
sgfn
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation for Fishjam simulcast, covering both conceptual behavior and practical integration steps for React (Web) and React Native.
Changes:
- Add a new how-to guide describing how to configure
sentQualitiesand select variants viasetReceivedQuality. - Add a new explanation page covering simulcast concepts, variants, and sender/receiver behavior.
- Update React and React Native examples docs to mention simulcast/quality selection.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| docs/how-to/features/simulcast.mdx | New how-to guide with sender config + receiver quality selection examples. |
| docs/explanation/simulcast.mdx | New conceptual overview explaining simulcast variants and flow. |
| docs/examples/react.mdx | Updates example description to mention simulcast quality selection. |
| docs/examples/react-native.mdx | Updates example description to mention simulcast quality selection. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
czerwiukk
force-pushed
the
FCE-3096/document-simulcast
branch
from
bf0a776 to
bcce4fe
Compare
| ### After | ||
|
|
||
| ```tsx | ||
| // @errors: 2739 |
There was a problem hiding this comment.
what changed here? why do we need to ignore this error now?
| function RTCView({ stream }: { stream: any }) { | ||
| return <View />; | ||
| } |
There was a problem hiding this comment.
|
|
||
| --- | ||
|
|
||
| ## Type differences: `Track` vs `RemoteTrack` |
There was a problem hiding this comment.
I would add a note somewhere that specifies what happens when the user selects a nonexistent variant. E.g. sender sends low and high, and the receiver chooses medium.
docs/explanation/simulcast.mdx
Outdated
|
|
||
| ## Why Simulcast? | ||
|
|
||
| Without simulcast, every receiver gets the same video quality. This creates a trade-off: send high quality (wastes bandwidth for small thumbnails) or send low quality (degrades the experience for full-screen viewers). |
There was a problem hiding this comment.
question: "wastes bandwidth for small thumbnails". What are thumbnails in that context?
There was a problem hiding this comment.
low resolution previews, eg. in a dense grid
docs/explanation/simulcast.mdx
Outdated
|
|
||
| Without simulcast, every receiver gets the same video quality. This creates a trade-off: send high quality (wastes bandwidth for small thumbnails) or send low quality (degrades the experience for full-screen viewers). | ||
|
|
||
| Simulcast eliminates this trade-off. A sender publishes multiple variants, and each receiver requests only the quality it needs: |
There was a problem hiding this comment.
suggestion:
send high quality (wastes bandwidth for small thumbnails)
Simulcast eliminates this trade-off.
Simulcast does not eliminate this. You still need to send high-quality regardless. I'd change it to:
"send high quality" => "receive high quality"
This is what the trade-off is. Simulcast is actually worse for the senders bandwith.
czerwiukk
force-pushed
the
FCE-3096/document-simulcast
branch
from
eae5362 to
e8e5caa
Compare
Description
Adds simulcast documentation.