Recording Mechanisms

The Dolby Interactivity APIs platform offers a few recording mechanisms that depend on the conference type and the liveRecording parameter setting. When liveRecording is enabled, the platform uses a special Mixer participant who records a conference.

Mixer

Mixer is a participant who uses the enabled MixingOptions parameter to join conferences. This option allows the application to treat Mixer as a special participant who is not visible to other conference participants. Mixer is responsible for recording conferences in MP3 or MP4 format.

Recording types

The Dolby Interactivity APIs platform uses recording mechanisms based on the conference type and the liveRecording parameter:

  • Recording audio during Dolby Voice conferences does not require setting the liveRecording parameter. The audio recording is always available in MP3 file and can be downloaded just after the end of a conference. This recording mechanism does not use Mixer.
  • If liveRecording is set to true, the platform uses Mixer to record a conference. After the conference, the recorded file, in MP3 or MP4 format, is available for download. The recording is also available via the replay method.
  • If liveRecording is set to false, the platform uses a recording mechanism that does not use Mixer. The recorded conference is available only via the replay method.

To select the required recording format, either MP3 or MP4, configure the recording options in the dashboard before creating a conference. For more information about setting the recording preferences, see the Recording document.

Recording conferences using Mixer

When any conference participant calls the start method to start the recording, Mixer joins a conference and begins recording the conference. The recording stops when Mixer leaves the conference, which occurs when the participant who started the recording calls the stop method or when the conference ends.

Application users can record conferences using any layouts, even different from layouts used during conferences. To change the default recording layout, provide the desired Recording Mixer Layout URL in the dashboard. The recording layout is only visible to Mixer; other conference participants cannot see the recording layout during a conference.

Diagram that represents a mechanism of recording conferences using Mixer

Recording conference without Mixer

When liveRecording is set to false, the recorded conference is available only via the replay method. The recording starts when a conference participant calls the start method. The recording stops when a participant calls the stop method or when the conference ends.

Dolby Interactivity APIs offer the Remix REST API to create MP3 or MP4 files out of recordings that are available only via replay. The Remix REST API allows Mixer to access the recorded conference using the replay method, record the replayed conference, and generate the files after the end of the replay.

If you wish to download the recording after a conference, we recommend either recording audio during the Dolby Voice conference or enabling liveRecording and using Mixer. The recording mechanism that uses the Remix REST API is more time-consuming because Mixer needs to replay the entire conference to create MP3 or MP4 files.

Diagram that represents a mechanism of recording conferences without Mixer

Accessing recordings

The conference recordings are available in the dashboard, via Recording.Audio.Available or Recording.MP4.Available webhook events, or REST APIs. For more information, see the Recording document.