Recording

Recording refers to the feature where media will be generated capturing any audio, video, messages, or screen and file sharing that occurred during a conference call. You can retrieve these recordings for any purpose that suits your needs. Some common uses include:

  • distribution to those unable to attend a meeting
  • broadcasting session on another video platform
  • archiving important meetings
  • post-processing or editing of content
  • etc.

This guide will walk you through some of the options available to you for enabling and retrieving these recordings through the Dashboard, Webhooks, or Recording API. The key concepts for creating recordings to be aware of:

  • Configure any recording settings in your account dashboard
  • Create a conference with live recording enabled
  • Trigger the startRecording event to begin recording
  • Get notified through webhook when recording is completed.

By following those steps you'll start generating recordings. In the following section the ways of retrieving those recordings will be discussed.

Recording Settings

One of the first things to consider is how you want video to be captured as there are a few options. You can adjust these settings by going to your developer dashboard and selecting your App. These "Third party" settings are on the same page as your Keys.

  • Recording: Record each stream independently You can toggle this setting if you want separate videos for each participant. By default on most accounts this will be turned off which will capture just a single recording for the session.
  • Recording: File format output This option allows you to choose if you just want MP3 audio, MP4 audio + video, or both types of files independently.
  • Recording: Mixer Layout URL Optionally, you can customize the default recording layout by creating an mixer layout app. You can take the default mixer layout app from here.

Start Recording

There are two ways to tell Voxeet to start the recording. You can either create a meeting that will be automatically recorded, or provide a UI control and let end user choose when to start the recording.

createConference with liveRecording option

The createConference function in the SDK takes a number of parameters. The parameter you want to pay attention to is liveRecording. This is a boolean that must be set to true if you want recordings to be generated during the session. When this option is used, the MPx file is automatically generated at the end of the conference for the customer to query and download using the Recordings REST API.

start recording mid-conference

The start method should be called when you want recording of a live session to begin. If you use the voxeet-conference-app there will already be a UX component with the appropriate event. When this method is used, the customer must call the Remix API when the recording has stopped in order to generate and retrieve the recorded file.

Retrieve Recordings

If you followed the Getting Set Up section you should begin generating recording files. This section will review how to retrieve them. There are three ways to accomplish this:

  • You can download the recordings directly from your developer dashboard
  • You can configure webhooks that will be called for related recording events
  • You can use the REST API and explore what recordings are available on demand

Let's look at those options now.

Dashboard Download

Whenever a recording is captured, you can manually go into your developer account dashboard and just download the media directly.

1. Login and click your Dashboard
2. Select your app from Your Apps
3. Select the Monitor heading
4. Find and select your session by conference alias, id, or date range
5. Click Download from the Recording section

It looks like the following:

download recording

Set Up WebHooks

For more information regarding Webhooks, refer to this page.

The Webhooks Recording.Live.InProgress and Recording.MP4.Available are the most relevant for recordings.

Use REST APIs

Recordings

If the MPx recording files are already generated, you can use the Recordings API to query, download and delete the files. Note the Recordings API requires Bearer authorization, refer to the Authentication topic for more details.

Remix

If start method was used to trigger the recording, then you need to access the Remix API to mix and download the recording.

Recording Format

The default mixer layout behaves as following:

  • For a meeting without any shared content, it places the participants in tiles in the layout.
  • For a meeting with shared content, it places content in full with just the presenter's video thumbnail.

The recordings are in MP4 container unless otherwise configured for audio only in MP3. Video is encoded in H.264, The container resolution is 1280x720 at 30fps. Audio is encoded in AAC at 48KHz, stereo with bitrate at 125kbps.

Additional Resources

You can learn how to use this feature on various platforms with the SDK: JavaScript | iOS | Android

The REST API provides additional resources for downloading, listing, and deleting these file based recordings.