2020 API AWARDS WINNER - BEST IN MEDIA APIs LEARN MORE

Recording

The recording option records all media shared during a conference, such as shared files, video and audio captured by participants' cameras and microphones, and shared screens. It is useful for distributing recordings among absent participants, broadcasting sessions to other platforms, archiving important meetings, or if post-processing is needed.

To record a conference, configure the recording settings in the dashboard:

  1. Select the SIGN IN link located in the upper right corner of the Dolby.io page. Log in using your email and password.
  2. Click the DASHBOARD link visible in the upper right corner of the website.
  3. Select your application from the APPLICATIONS category located on the left side menu.
  4. Select the Interactivity APIs category from the drop-down menu visible under your application.
  5. Select the Settings tab at the top of the window and check the `Recording` section.

The Recording Mixer Layout URL option allows customizing the default recording layout by providing a mixer layout URL.

The Generate audio recordings for each participant option records every audio stream as a separate file. This option is turned off by default, as it has a cost impact. Recording each stream independently requires a longer post-processing time, therefore it requires more time to receive the Recording.MP4.Available webhook with a link to the recorded files.

To choose the desired recording format, check the Recording File Format Output field and select an option from the drop-down list:

  • MP3 if you wish to receive an audio recording.
  • MP4 if you wish to receive a video recording.
  • BOTH if you wish to receive two recordings: audio and video.

Every conference is recorded as a video, in MP4 format. Audio recordings in MP3 format are extracted from the MP4 files. Video is encoded using the H.264 codec. The container resolution is 720p (1280x720) at 30fps. Audio is encoded using the AAC codec, with a 48kHz sample rate, and variable bitrate.

The recording layout depends on what is shared during a conference:

  • If no media are shared, only a blank page with users' avatars is captured.
  • If some media are shared (videos, files, or shared screens) they are displayed in a full-screen mode. If a presenter additionally shares a video from his camera, the video is visible as a thumbnail in the corner of the screen.
  • In a conference when only video from participants' cameras are shared (without any other shared media), the videos are displayed in the participant's areas (full-screen, half-screen, or otherwise, depending on the number of participants).

Recording a conference

To record a conference, use the recording service. The start method turns the recording on. To use live recording, you must specify the parameter when creating a conference. The liveRecording parameter turns the live recording on and off.

  • When set to true, the recorded file is available at the end of the call and can be downloaded immediately.
  • When set to false, the remix API must be called after the conference to generate and retrieve the recorded file.

The liveRecording parameter does not start the recording; the start API is still required. Every participant can record a conference.

To stop the recording, use the stop API.

Download recordings

There are three ways to download recordings:

Download the recording from your dashboard:

  1. Select the SIGN IN link located in the upper right corner of the Dolby.io page. Log in using your email and password.
  2. Click the DASHBOARD link visible in the upper right corner of the website.
  3. Select your application from the APPLICATIONS category located on the left side menu.
  4. Select the Interactivity APIs category from the drop-down menu visible under your application.
  5. Select the Monitor tab at the top of the window.
  6. Find the proper conference. To search, use the conference alias, ID, or a date.
  7. In the Recording section, select the Download option.

Listen to webhook event

Configure webhooks and use the URL included in the Recording.MP4.Available webhook. This webhook is sent when the recording is ready and can be downloaded. If you want to receive the MP3 and MP4 files, the URL in the webhook is a joint string with the "|" sign used as a separator.

Use REST API

Use the recording REST API to check recording details, download the recording, or delete the recording.

Replaying conferences

All recorded conferences can be replayed. Replay requires the usage of the replay API. If you create more than one recording during a conference, all of the recordings are combined and replayed, one after another.