Table of Contents
- Table of Contents
- SignalWire Video Conferencing API
- Getting Started
- Frontend Docs
- Backend Docs
- Join or create temporary room session.
- Screen share
- Change devices or layouts.
- List Active Room Sessions with Rooms Previews
- Join active Rooms from list.
- Meeting controls (Mute Audio and Video)
- Create Persistant Rooms.
- Create Invite Links to join a room session.
SignalWire Video Conferencing API
Other video conferencing APIs and applications rely on SFU (Selective Forwarding Unit) which means every user is responbile for streaming to and decoding the streams of other users. The SignalWire Video Conferencing API takes an MCU (Multipoint Control Unit) approach which reduces the load on the end users and results in minimized latency and the ability to participate in large-scale calls within a browser.
The application has two parts, the frontend and the backend. They’re built to run independantly but the frontend does require the backend in order to make requests to the SignalWire Video API. Instructions are provided for running each independantly in a virtual environment using replit.com or running locally on your machine.
This guide walks you through setting up the example application using a terminal and NodeJS. At the time of writing this it has been tested on OSX and Linux.
This guide walks you through using Replit, a cloud based coding environment, to run both the backend and the frontend. The end result is a hosted instance with a link that can be shared for others to use.
The frontend is built in Vue 3. This doc goes over all the components, framework specific details, and the api helper class.
The backend is a simple NodeJS Express server. It interacts with the SignalWire API.