FCE-3775 Document videoCodec Sandbox API parameter - #288
Merged
Merged
Conversation
6 tasks
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The published OpenAPI reference omits videoCodec and its 409 conflict behavior.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 1
Open (1)
What changed in this PR
Documents Sandbox API video codec selection, including VP8 defaults, H.264 overrides, and 409 conflict behavior.
Changes:
- Adds
videoCodecguidance to the Sandbox API testing guide. - Explains codec defaults and overrides on the rooms page.
| File | Summary |
|---|---|
docs/how-to/backend/sandbox-api-testing.mdx |
Documents the optional codec parameter and 409 behavior. |
docs/explanation/rooms.mdx |
Describes Sandbox API codec defaults and overrides. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Gawor270
marked this pull request as ready for review
September 23, 2026 11:42
czerwiukk
approved these changes
Sep 23, 2026
Karolk99
approved these changes
Sep 24, 2026
Gawor270
added a commit
to fishjam-cloud/web-client-sdk
that referenced
this pull request
Sep 25, 2026
## Description
- Add an optional `options` argument (`{ videoCodec }`) to
`getSandboxPeerToken` and `getSandboxLivestream`, after the existing
`roomType` / `isPublic` arguments
- Send `videoCodec` (`vp8` | `h264`) with both requests
- Show a clear error when the room already exists with a different room
type or video codec (409)
- Export `VideoCodec` and `SandboxOptions` from react-client and
mobile-client
## Motivation and Context
The Sandbox API now accepts a `videoCodec` query parameter; compositions
need H.264 rooms.
## Documentation impact
- [ ] Documentation update required
- [x] Documentation updated [in another
PR](fishjam-cloud/documentation#288)
- [ ] No documentation update required
## Types of changes
- [ ] Bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to
not work as expected)
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.
Description
The Sandbox API now accepts an optional
videoCodecquery parameter.videoCodecvideoCodecand its 409 conflict behavior in the Sandbox API testing guide