Skip to content
Docs

Recording

Learn how RealtimeKit records meetings as a single composite file or as separate participant audio tracks.

Visit the following pages to learn more about recording meetings:

RealtimeKit can record the audio and video of multiple users in a meeting, as well as interactions with RealtimeKit plugins, in a single file using composite recording mode. RealtimeKit can also record separate participant audio tracks using track recording.

How composite recording works

Composite recordings are powered by anonymous virtual bot users who join your meeting, record it, and then upload it to RealtimeKit's Cloudflare R2 bucket. For video files, we currently support the H.264 and VP8 codecs.

  1. When the recording is finished, it is stored in RealtimeKit's Cloudflare R2 bucket.

  2. RealtimeKit generates a downloadable link from which the recording can be downloaded. You can get the download URL using the Fetch details of a recording API or from the Developer Portal.

    You can receive notifications of recording status in any of the following ways:

    • Using the recording.statusUpdate webhook. RealtimeKit uses webhooks to notify your application when an event happens.
    • Using the Fetch active recording API.
    • You can also view the states of recording from the Developer Portal.
  3. Download the recording from the download url and store it to your cloud storage. The file is kept on RealtimeKit's server for seven days before being deleted.

    You can get the download URL using the Fetch active recording API or from the Developer Portal.

    We support transferring recordings to AWS, Azure, and DigitalOcean storage buckets. You can also choose to preconfigure the storage configurations using the Developer Portal or the Start recording a meeting API.

Workflow

A typical workflow for recording a meeting involves the following steps:

  1. Start a recording using the Start Recording API or client side SDK.
  2. Manage the recording using the Pause, resume, or stop recording API or client side SDK.
  3. Fetch the download URL for downloading the recording using the Fetch details of a recording API, webhook, or from the Developer Portal.

For separate participant audio files, refer to Track recording.