NEWDolby Interactivity APIs are now the Dolby.io Communications APIs Learn More >
X

Recording

The Dolby.io Communications APIs allow recording all media shared during a conference, such as shared files, screens, and media captured by participants' cameras and microphones. The recording option is useful for distributing recordings among absent participants, broadcasting sessions to other platforms, archiving important meetings, or post-processing.

Video recordings are available using the H.264 codec and 1080p (1920 x 1080) at 30fps resolution. Video recordings are available for both Dolby Voice and non-Dolby Voice conferences.

Audio-only recordings are also available. The SDK records Dolby Voice conferences in the MP3 audio format. For non-Dolby Voice conferences, the SDK creates video recordings in the MP4 format and extracts audio MP3 files out of the video recordings.

The recording layout depends on the shared media:

  • When participants do not share any media during a conference, the recording includes only a blank page with participants' avatars.
  • When participants use cameras and do not share any other media, the recording includes the participant's videos in the participant's areas (full-screen, half-screen, or otherwise, depending on the number of participants).
  • When participants share additional media, such as files or screens, the recording includes the shared media in a full-screen mode. When a presenter additionally shares a video from a camera, the video is visible as a thumbnail in the corner of the screen.

Set the recording preferences

To set the recording preferences, 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 Communications 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.

6. Select the desired options:

  • 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 all audio streams separately. This option is disabled by default. In the case of non-Dolby Voice conferences, recording each stream independently requires a longer post-processing time.

  • The Recording File Format Output field allows choosing the desired recording format 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

Record a conference

1. Set the liveRecording parameter to true while you create a conference. This option allows you to download the recording immediately after the end of a conference. Otherwise, you should call the remix REST API after the end of a conference to generate and retrieve the recorded file.

2. Call the start method to start the recording. This option is available for all participants.

3. Call the stop method to stop the recording.

Download the recording

Note: If you did not enable the liveRecording parameter, call the remix REST API after the end of the conference to generate and retrieve the recorded file.

There are three ways to download recordings:

Download the recording from 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 Communications 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 events

Use webhook events to receive notifications informing that the conference recording is ready and can be downloaded through the URL link included in the webhook event. Dolby.io Communications APIs offer the following webhook events:

  • Recording.Audio.Available: Available for Dolby Voice conferences, the webhook events include links to MP3 audio recordings.

  • Recording.MP4.Available: Available for Dolby Voice and non-Dolby Voice conferences:

    • In the case of Dolby Voice conferences, the webhook events include links to video recordings in MP4 format.
    • In the case of non-Dolby Voice conferences, the webhook events can include links to audio recordings in MP3 format or video recordings in MP4 format, depending on the selected format. The BOTH recording option allows receiving links to audio and video recordings in MP3 and MP4 format and does not allow receiving separate recordings for selected conference participants (split recording).

The splits webhook element allows receiving separate audio recordings for each conference participant. This option is only supported for audio recordings. To use the split recording, enable the Generate audio recordings for each participant option in the dashboard.

Note: Split recording is only supported for Dolby Voice-enabled conferences.

To receive both recording formats in the case of Dolby Voice conferences, select the BOTH recording format and use Recording.MP4.Available and Recording.Audio.Available webhook events.

Use REST API

Use the recording REST API to access the recording details, download recorded conferences, or delete recordings.

Replay a conference

To replay the recorded conference, use the replay API. If you created more than one recording during a conference, the recordings are combined and replayed, one after another.


Did this page help you?