Composite Recordings
100ms can record a session to capture the perspective of a participant, who can hear and see other participants in the room. These recordings are a composite of multiple audio/video tracks across multiple participants in the session. The output is a single MP4 file. There are 2 types of Composite Recordings - Browser Composite and Custom Composite. Depending on the use case, the ideal composite type can be selected.
Browser Composite Recordings Basics
- These are browser based recordings which records the screen to generate a composite recording file.
- They can be started automatically when the first peer joins and stopped after all peers leave with a timeOut configuration.
- Alternatively, they can also be started and stopped via client SDK or Recording APIs
- Customizable settings: You can define which roles to record, which video resolution to record and, other modifications to the UI.
Guide to Browser Composite Recordings
Follow this guide for browser based composite recordings:
Enable Browser Composite Recordings
Set up browser composite recording using recording configuration on 100ms dashboard →
- Set up which roles to be recorded, video resolution, max recording duration time etc.
- Audio-only browser composite recordings: possible via the REST API to start recording
- Customize the composition UI
Start a browser composite recording
There are two ways to record a browse composite recording
- Auto Start - Start recording automatically when the first peer joins a room. Enable on dashboard →
- Start on demand
-
Start with API - Use 100ms server-side REST API which is suitable to start/stop based on business logic. Record with Recording APIs →
-
Start from SDK - Start recording with the client-side SDK. This is suitable to start/stop based on user action (click a button).
-
Stop, pause, resume a browser composite recording
Browser composite recording can be started either by 100ms Recording APIs or SDKs, whereas actions like stop, pause, resume can be achieved with:
- Stop a recording - Stop Recording API
- Pause a recording - Pause Recording API
- Resume a recording - Resume Recording API
Get browser composite recording assets
After the recording is stopped and processed, a recording asset is generated. Composite generates an asset of type room-composite. You can fetch this asset through multiple methods:
- Fetch on 100ms Dashboard
- Auto-send to your cloud storage location
- REST API to get recording asset
- Server-side webhooks: use the
beam.recording.successwebhook
