You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/glossary.md
+7-11Lines changed: 7 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,32 +8,28 @@ A brief walk-through of the terms we use in the documentation.
8
8
9
9
### Room
10
10
11
-
Collection of peers that can send and receive video/audio to and from other peers
11
+
A collection of peers that can send and receive video/audio to and from other peers.
12
12
13
13
### Peer
14
14
15
-
User that is connected to a room. Each peer has some associated metadata and tracks.
15
+
A user that is connected to a room. Each peer has some associated metadata and tracks.
16
16
17
17
### Track
18
18
19
-
Single stream of video or audio of a peer. It could be a camera view, shared screen or microphone audio. Each peer can
20
-
stream multiple tracks.
19
+
A single stream of video or audio from a peer. It could be a camera view, shared screen, or microphone audio. Each peer can stream multiple tracks.
21
20
22
21
### Management Token
23
22
24
-
Secret token that should be stored on your backend. It allows to create rooms and add peers.
23
+
A secret token that should be stored on your backend. It allows you to create rooms and add peers.
25
24
26
25
### Peer Token
27
26
28
-
Token that your backend should pass to end clients to allow access to a specific room.
27
+
A token that your backend should pass to end clients to allow access to a specific room.
29
28
30
29
### Fishjam URL
31
30
32
-
URL to your Fishjam instance. It is used by your backend server to add peers to rooms (and create rooms).
33
-
It is also
34
-
used by end client apps to join rooms.
31
+
The URL to your Fishjam instance. It is used by your backend server to add peers to rooms (and create rooms). It is also used by end client apps to join rooms.
35
32
36
33
### Room Manager
37
34
38
-
Our test app available **only** on Sandbox environment. It allows to test Fishjam without need to add create rooms
39
-
functionality on your backend.
35
+
Our test app is available **only** in the Sandbox environment. It allows you to test Fishjam without needing to add room creation functionality to your backend. You can find more details [here](/room-manager).
Copy file name to clipboardExpand all lines: docs/introduction.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,20 +7,20 @@ import { items } from "@site/src/content/cardItems";
7
7
8
8
# Introduction
9
9
10
-
Welcome to Fishjam documentation!
10
+
Welcome to the Fishjam documentation!
11
11
Here you will find everything you need to start building your multimedia streaming applications using Fishjam.
12
12
13
13
## What is Fishjam?
14
14
15
15
Fishjam is a multimedia streaming toolkit that allows you to build real-time video and audio streaming applications using [WebRTC](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API).
16
-
We provide the infrastructure, media server and client SDKs so you can focus on building your apps.
16
+
We provide the infrastructure, media server, and client SDKs so you can focus on building your apps.
17
17
18
18
**No WebRTC knowledge is required!**
19
19
20
20
## How can I try it out?
21
21
22
22
1. To get started with Fishjam, you need to create an account on our [developer panel](https://fishjam.io/app).
23
-
2. Once you have an account, Fishjam will assign you a sandbox instance automatically. Sandbox instances come with [**Room Manager**](/room-manager.md) - a simple backend for creating test rooms. Copy the _Fishjam URL_ and _Management Token_ from the developer panel.
23
+
2. Once you have an account, Fishjam will assign you a Sandbox instance automatically. Sandbox instances come with [**Room Manager**](/room-manager.md) - a simple backend for creating test rooms. Copy the Room Manager URL from the developer panel.
24
24
3. Pick a client SDK that you want to use and follow the Quick Start guide. We provide SDKs for [React Native](/react-native/quick-setup.mdx) and [React](/react/installation.mdx).
25
25
26
26
<QuickNavigation
@@ -32,9 +32,9 @@ We provide the infrastructure, media server and client SDKs so you can focus on
32
32
We are maintaining a simple video conferencing app called [Videoroom](https://room.fishjam.io/).
33
33
It is a publicly accessible app where you can see Fishjam in action.
34
34
35
-
You can access it at [room.fishjam.io](https://room.fishjam.io/) - just pick a room name and peer name and you can start a video call between any two devices.
35
+
You can access it at [room.fishjam.io](https://room.fishjam.io/) - just pick a room name and peer name, and you can start a video call between any two devices.
36
36
37
-
## Any examples I can run locally?
37
+
## Are there any examples I can run locally?
38
38
39
39
Yes! You can find examples in our GitHub repositories that you can run locally. Examples are usually available under the `examples` directory in the relevant repository.
Copy file name to clipboardExpand all lines: docs/room-manager.md
+18-12Lines changed: 18 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,26 +4,28 @@ sidebar_position: 4
4
4
5
5
# Room Manager
6
6
7
-
The **default sandbox app** comes with an HTTP server called **Room Manager**.
8
-
It allows you to start working on the Client App without having to setup an actual backend.
9
-
However, for production purposes, you need to bring own backend using our Server SDKs. Production apps doesn't have a corresponding Room Manager.
7
+
## App for Initial Development
8
+
9
+
The [**default Sandbox App**](https://fishjam.io/app/sandbox) comes with an HTTP server called **Room Manager**.
10
+
It allows you to start working on the Client App without having to set up an actual backend.
11
+
However, for production purposes, you need to bring your own backend using our Server SDKs. Production apps don't have a corresponding Room Manager.
10
12
11
13
:::danger[ROOM MANAGER IS NOT SAFE FOR PRODUCTION]
12
14
13
15
Room Manager doesn't implement any form of authentication.
14
16
Anyone using the same room name and peer name will receive **the same Peer Token!**
15
17
16
-
For production environment, make sure to [set up your own backend](/production/server.mdx) using our Server SDKs and authenticate the client on your own.
18
+
For a production environment, make sure to [set up your own backend](/production/server.mdx) using our Server SDKs and authenticate the client on your own.
17
19
18
20
:::
19
21
20
-
## Why should I use it?
22
+
## Why Should I Use It?
21
23
22
24
If you're a frontend developer and you want to quickly test your app, you can use the Room Manager to create a room and access it.
23
-
This way you can start building your app without having to deploy any serverside logic.
25
+
This way, you can start building your app without having to deploy any server-side logic.
24
26
25
27
:::note
26
-
When moving to production, the only change you will need to make is to retrieve the **peer token from your backend** instead of the room manager.
28
+
When moving to production, the only change you will need to make is to retrieve the **peer token from your backend** instead of the Room Manager.
27
29
:::
28
30
29
31
:::tip
@@ -34,18 +36,22 @@ It can be used as a reference for building your backend.
34
36
35
37
:::
36
38
37
-
## How do I use it?
39
+
## How Do I Use It?
38
40
39
-
Simply take the Fishjam instance url of your `sandbox` app, which should look like `https://fishjam.io/api/v1/connect/***`, append a
40
-
`/room-manager` path and use `roomName` and `peerName` query params to build an url for the GET request.
41
+
Simply log in to your Fishjam Dashboard and open the [Sandbox App](https://fishjam.io/app/sandbox). You will see your Room Manager URL there.
42
+
Now you need to add `roomName` and `peerName` query params to build a URL for the GET request.
`YOUR_APP_UUID` is your unique ID. Anyone who knows that ID can join your rooms. To reset this ID, you have to open the Sandbox App, press Settings, and Reset App.
0 commit comments