Skip to content

Commit 9b3d0f8

Browse files
Add simple documentation of audio-only rooms (#104)
## Description Closes FCE-1327 Adding basic documentation of what the benefits of using audio-only rooms are and how to use them.
1 parent 2bfbee5 commit 9b3d0f8

File tree

4 files changed

+57
-6
lines changed

4 files changed

+57
-6
lines changed

.spelling

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@ Xcode
3131
UI
3232
dev
3333
Podfile
34-
2.0
35-
2012
3634
TLDR
3735
frontend
3836
quicknavigation
@@ -43,7 +41,6 @@ item.title.tolowercase
4341
videoroom
4442
fishjam.io
4543
room.fishjam.io
46-
24
4744
unmuting
4845
programmatically
4946
unmute

docs/audio-calls.mdx

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
sidebar_position: 5
3+
---
4+
5+
import Tabs from "@theme/Tabs";
6+
import TabItem from "@theme/TabItem";
7+
8+
# Audio-only Calls
9+
10+
In many use cases, you only need real-time audio, without any video streaming.
11+
If your use case falls into this category, then you can benefit greatly from using `audio_only` rooms in Fishjam.
12+
13+
<!-- TODO(Tomasz Mazur): uncomment this once pricing page is ready -->
14+
<!-- ## Why Should I Care? -->
15+
<!---->
16+
<!-- Audio-only rooms are heavily discounted compared to normal rooms. -->
17+
<!-- As described in more detail on the [pricing page](https://fishjam.io/#pricing), Fishjam rooms are priced based on the total connection time of peers in them. -->
18+
<!-- Audio-only rooms come at a 75% discount. -->
19+
<!-- For example, if you have a normal room with 2 peers connected for 30 minutes, then the total cost of the room will be equal to the cost of 60 minutes. -->
20+
<!-- If the same room were audio-only, then the final cost of the room will only be equal to 15 minutes. -->
21+
22+
## How Do I Use It?
23+
24+
Using this feature is as easy as setting the `roomType` field to `audio_only` when creating a room using our [Server SDKs](/production/server)
25+
26+
<Tabs groupId="language">
27+
<TabItem value="ts" label="Typescript">
28+
29+
```ts
30+
const createdRoom = await fishjamClient.createRoom({ roomType: 'audio_only' });
31+
```
32+
33+
</TabItem>
34+
35+
<TabItem value="python" label="Python">
36+
37+
```python
38+
options = RoomOptions(room_type="audio_only")
39+
created_room = fishjam_client.create_room()
40+
```
41+
42+
</TabItem>
43+
</Tabs>
44+
45+
Now, you can connect peers normally to the room as described in our [React Native](/react-native/connecting) and [React](/react/connecting) docs.
46+
47+
:::info
48+
The React Native and React SDKs will log a warning in the console if any attempt to add video to an audio-only room is made.
49+
This aims to assist in debugging, as adding video to an audio-only room does nothing and is most likely a mistake.
50+
:::
51+
52+
### Screen sharing
53+
54+
If you attempt to screen share when connected to an `audio_only` room, then only the audio will actually be sent to the other peers.

docs/production/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Going to production",
3-
"position": 6,
3+
"position": 7,
44
"link": {
55
"type": "generated-index"
66
}

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"typecheck": "tsc",
1818
"format": "prettier . --write",
1919
"format:check": "prettier . --check",
20-
"spellcheck": "mdspell '**/*.md' '**/*.mdx' '!node_modules/**' '!packages/**' '!docs/api/**' --en-us",
20+
"spellcheck": "mdspell '**/*.md' '**/*.mdx' '!node_modules/**' '!packages/**' '!docs/api/**' --en-us --ignore-numbers",
2121
"spellcheck:report": "yarn spellcheck -r"
2222
},
2323
"dependencies": {
@@ -57,4 +57,4 @@
5757
"node": ">=18.0"
5858
},
5959
"packageManager": "yarn@4.5.3"
60-
}
60+
}

0 commit comments

Comments
 (0)