Skip to content

Commit 15e2e29

Browse files
FCE-1215: Add documentation about unsupported codecs (#95)
## Description - Added codecs info
1 parent 0483a87 commit 15e2e29

File tree

3 files changed

+35
-2
lines changed

3 files changed

+35
-2
lines changed

.spelling

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,9 @@ JoiningRoom
7474
updating.mdx
7575
UpdatingMetadata
7676
reading.mdx
77-
ReadingMetadata
77+
ReadingMetadata
78+
codecs
79+
H.264
80+
VP8
81+
codec
82+
bitrates

docs/api/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "API",
3-
"position": 9,
3+
"position": 10,
44
"link": {
55
"type": "generated-index",
66
"description": "API documentation for Web and Mobile SDKs."

docs/troubleshooting.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
sidebar_position: 9
3+
---
4+
5+
# Troubleshooting
6+
7+
## Supported Video Codecs
8+
9+
Fishjam supports the following video codecs:
10+
11+
- **H.264**
12+
- **VP8**
13+
14+
## Default Codec
15+
16+
Fishjam uses H.264 by default, however, to solve issue with Android emulators, VP8 is set when you're using Room Manager on Sandbox.
17+
18+
### Changing the Codec
19+
20+
Override the default codec by setting the `codec` parameter when [creating a room](/api/server/interfaces/RoomConfig#videocodec) using server SDKs.
21+
22+
### Why VP8 and H.264?
23+
24+
- **VP8**: A software-based codec supported across all devices, ensuring maximum compatibility. It's ideal for environments lacking hardware acceleration, such as Android emulators.
25+
- **H.264**: A hardware-accelerated codec offering superior performance. However, its availability varies by device, and it may not perform optimally at lower bitrates.
26+
27+
For optimal performance and compatibility, assess your application's requirements and the environments in which it will operate when selecting a codec.
28+
We recommend using H.264 for production and VP8 for development as it works with Android emulators.

0 commit comments

Comments
 (0)