Skip to main content

Introduction

Welcome to Fishjam Cloud documentation!
Here you will find everything you need to start building your multimedia streaming applications using Fishjam Cloud.

What is Fishjam Cloud?

Fishjam Cloud is a multimedia streaming toolkit that allows you to build real-time video and audio streaming applications using WebRTC. We provide the infrastructure, media server and client SDKs so you can focus on building your apps.

No WebRTC knowledge is required!

How can I try it out?

  1. To get started with Fishjam Cloud, you need to create an account on our developer panel.
  2. Once you have an account, Fishjam Cloud will assign you a sandbox instance automatically. Sandbox instances come with Room Manager - a simple backend for creating test rooms. Copy the Fishjam URL and Management Token from the developer panel.
  3. Pick a client SDK that you want to use and follow the Quick Start guide. We provide SDKs for React Native and React.

Do you have any running examples?

We are maintaining a simple video conferencing app called Videoroom. It is a publicly accessible app where you can see Fishjam Cloud in action.

You can access it at room.fishjam.io - just pick a room name and username and you can start a video call between any two devices.

Any examples I can run locally?

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.

The easiest starting point for both web and mobile is Fishjam Chat. It is a simple chat application that uses Fishjam Cloud for video and audio streaming. You can find the code here:

What does Fishjam Cloud consist of?

Fishjam Cloud consists of several components that work together to provide a seamless multimedia streaming experience. Below is a list of components that you will need to get started:

ComponentDescriptionLink
Developer panelDeveloper panel for setting up your own Fishjam Media Server.fishjam.io/app
Fishjam Media ServerA media server that will route your multimedia traffic. We host and manage it for you. You can control it via the developer panel.
Fishjam Client SDKsToolkit used for multimedia integration on endpoint devices.React Native, React
Fishjam Server SDKsToolkit for integrating your backend with Fishjam. We support Python and NodeJS as well as REST API.Python, NodeJS, and REST
Room ManagerSimple backend for creating test rooms. You no longer need to bring your own backend to develop frontend apps.Repository

How does it work?

Streaming with Fishjam Cloud is simple. You create a room, add peers to it, and start streaming. Below is a high-level overview of how Fishjam Cloud works.

Fishjam Cloud Data Flow