Skip to content

FCE-3775 Document videoCodec Sandbox API parameter #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Gawor270 merged 2 commits into from
Sep 25, 2026
Merged

FCE-3775 Document videoCodec Sandbox API parameter #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d99e6a
FCE-3775 Document videoCodec Sandbox API parameter
Gawor270 Sep 23, 2026
d67846e
Clarify videoCodec docs and add a raw request example
Gawor270 Sep 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/explanation/rooms.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,9 @@ Fishjam supports the following video codecs:
- **H.264** — A hardware-accelerated codec offering superior performance. Used by default. Its availability varies by device, and it may not perform optimally at lower bitrates.
- **VP8** — A software-based codec supported across all devices, ensuring maximum compatibility. Ideal for environments lacking hardware acceleration, such as Android emulators.

Fishjam uses H.264 by default, however, to solve an issue with Android emulators, VP8 is set when you're using the Sandbox API.
Fishjam uses H.264 by default. To solve an issue with Android emulators, the Sandbox API uses VP8 unless you pass the `videoCodec` query parameter (`vp8` or `h264`). Use H.264 if you want to [compose a room](../how-to/compositions/compose-a-fishjam-room) created with the Sandbox API.

You can override the default codec by setting the `codec` parameter when [creating a room](../api/server/interfaces/RoomConfig#videocodec) using server SDKs.
You can override the default codec by setting the `videoCodec` parameter when [creating a room](../api/server/interfaces/RoomConfig#videocodec) using server SDKs.

We recommend using H.264 for production and VP8 for development as it works with Android emulators.

Expand Down
5 changes: 5 additions & 0 deletions docs/how-to/backend/sandbox-api-testing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@ You need both values for React/React Native apps:
### Optional parameters

- `roomType` - Type of room to create (defaults to `conference`)
- `videoCodec` - Video codec of the room: `vp8` (default) or `h264`. Accepted by both the peer and the livestream endpoints. Joining an existing room with a different codec returns `409 Conflict`; omit it to join a room regardless of its codec.
Comment thread
Gawor270 marked this conversation as resolved.

```bash
curl "$SANDBOX_API_URL?roomName=testRoom&peerName=testUser&videoCodec=h264"
```

### Room types available

Expand Down
Loading