Cloudzilla
Logo
arrow left
Back to Developer Education

Agora Cloud Recording

Agora Cloud Recording

In this tutorial, we will be building a server using Node.js and Express to start and stop cloud recording of audio/video streams that occur using Agora SDKs in your application using the Cloud Recording APIs. <!--more-->

The client application that's using the Agora SDKs should request this server to record the streams. Then, the server will request the Agora APIs on behalf of the client application. This will ensure that credentials for the Agora APIs are secure rather than exposing them in the app.

Goals

By the end of this tutorial, you’ll know:

  • How Agora's cloud recording works.

  • The difference between cloud recording and on-premise recording.

  • How to set up an Express server to acquire recording resource, start and stop cloud recording.

Prerequisites

This tutorial is for applications that use Agora and want to implement cloud recording. If you are not using Agora in your application, then this tutorial is not for you.

If you'd like to learn how to build some applications with React Native and Agora, refer to the articles below.

The fundamentals of Node.js and Express will not be covered in this tutorial. If you are not comfortable with the fundamentals, this is a helpful tutorial that you can go through before beginning with this project.

You'll need Node.js to set up an Express server. I'll be using Postman to make requests to this server to test it.

Agora

Agora.io was founded in 2014. It's a service provider for real-time voice and video. Its core technology is real-time communication (RTC).

Agora provides SDKs to build apps that require real-time engagement like:

  • Audio/Video Calls.

  • Interactive Livestreaming (Audio/ Video).

  • Interactive Gaming.

  • Real-Time Messaging (which is in BETA at the time of writing this article).

Agora is a paid service, but the first 10,000 minutes are free every month. You can check their pricing page for a comprehensive breakdown.

If you'd like to learn more about Agora, visit their website or read this article.

Overview

We'll be going through these steps in this article:

  1. Cloud recording vs. On-Premise recording.
  2. Enabling Cloud Recording in Project management console.
  3. Acquiring Customer ID and Customer Secret for Agora APIs
  4. Setting up the server.
  5. Acquire resource ID.
  6. Start recording.
  7. Stop recording.
  8. Recap.

You can refer to the final code in this GitHub repository.

Cloud recording vs. On-Premise recording.

Cloud recording is used to record and save voice calls, video calls, and interactive streaming on your cloud storage. You can record one-to-one or one-to-many audio and video calls. For cloud recording, Agora provides APIs to record the streams. Once the recording ends, Agora will upload the recorded video to your cloud storage.

Agora supports uploads to Amazon S3, Qiniu Cloud, Alibaba Cloud, Tencent Cloud, Kingsoft Cloud.

I recommend using Amazon S3 as it is easy to set up. Agora will need the bucket name, the access key, and the secret key for the bucket to upload the recorded files to your cloud storage.

On-Premise recording is similar to cloud recording, but you need to set up your own Linux server using the components provided by Agora to record the streams.

Compared with On-premise Recording, Cloud Recording is more convenient as it does not require deploying Linux servers.

If you'd like to learn more about the differences between cloud recording and on-premise recording, refer to this FAQ answer.

Agora will bill you for the cloud recording service. You can check their billing policies for more information.

Enabling cloud recording in the project management console

To use cloud recording in your application, you must enable cloud recording from the Agora Project Management Console.

Head to the console and open Project Management.

Click on usage for the project you want to enable cloud recording for.

You can acquire the app ID right next to the Usage button. Click on the eye icon to reveal the app ID. We'll be needing the app ID later in this tutorial.

Usage Button

Click on duration under cloud recording. If you haven't already enabled it yet, It will ask you whether you want to enable cloud recording for this project. Click on the enable button.

Enable Cloud Recording

It'll display the maximum number of channels that you can record at the same time. The default value is 50 channels. If you want more, you need to contact the Sales team of Agora (sales@agora.io).

Max Concurrent Channels

Once you hit Apply, you'll see the statistics page of the cloud recording.

Cloud Recording Enabled

You have successfully enabled cloud recording for your project.

Acquiring customer ID and customer secret for Agora APIs

If you want to work with Agora's APIs, you need to acquire the customer ID and customer secret from Agora.

Head to the console and click the account name on the top right corner and click on RESTful API from the dropdown.

RESTful API Dropdown

Copy the customer ID and click on download under customer secret to get the customer secret.

You can download the customer secret only once. Keep the secret in a safe place.

Customer Secret

For the API, we should convert the customer ID and secret to base64 using the Buffer.from() and converting it into a base64 string using .toString('base64).

Buffer.from(string).toString('base64');

I'll be using Axios to make requests to the Agora APIs. We need to pass the constructed base64 string as the authorization header on the request. You can learn more about Axios on the Axios nmp package page.

To install Axios, run:

npm install axios

It is not a good idea to add the key and the secret in the code. So, you can use environment variables. If you'd like to learn more about environment variables, refer to this article.

Setting up the server

Let's install Express using NPM.

npm install express

Now, we can import express in our code to create a simple server module that'll listen on port 3000.

const express = require("express");
const app = express();
app.use(express.json());

app.get("/", (req, res) => res.send("Agora Cloud Recording Server"));

const port = process.env.PORT || 3000;
app.listen(port, () => console.log(`Agora Cloud Recording Server listening at Port ${port}`));

You can start the server by running:

node index.js

This server will be listening on port 3000 and when you hit the '/' endpoint, it'll send "Agora Cloud Recording Server".

Recording

We need to use the RESTful APIs in the following sequence.

  1. Acquire resource.
  2. Start recording.
  3. Stop recording.

First, you need to acquire a resource ID for cloud recording. This will allocate a recorder on Agora's servers for you to record the streams. Then, we need to start the recording within 5 minutes from acquiring the resource ID. You can stop the recording whenever you want.

During the recording, you can query the recording session for the status, update the layout of the recording, and, update the subscriber list. To learn more about them, refer to the documentation.

We need to provide a UID for the recorder. The recorder is like a user who joins the channel, records the stream, and uploads it to the storage. So make sure you provide a unique UID to the recorder that doesn't conflict with an existing user in the channel.

If you have set up token authentication for your Agora project, you should also pass a token in the body. To learn more about token authentication, refer to this article.

At the time of writing this article, Agora cloud recording does not support user accounts yet. Make sure that the recording channel uses integer UIDs. If you'd like to learn more about user accounts, refer to this FAQ answer.

Acquire resource ID

Let's add a POST request handler for a new endpoint called '/acquire' to acquire the resource ID for the cloud recording.

app.post("/acquire", (req, res) => {
  // Acquire Cloud Recording Resource ID Here
});

You need to request this endpoint https://api.agora.io/v1/apps/{appId}/cloud_recording/acquire to get a resource ID. The endpoint URL should contain the Agora app ID.

In the body of the request, We should specify a UID, the channel ID, and the time limit (in hours) for the cloud recording API calls. The time limit must be between 1 hour and 720 hours. The countdown starts when you start the recording. When you exceed the limit, you can no longer call query, updateLayout, and stop.

If this request succeeds, you'll get a resource ID as the response. You need to start recording with this resource ID within five minutes.

app.post("/acquire", async (req, res) => {
  const Authorization = `Basic ${Buffer.from(`${process.env.CUSTOMERID}:${process.env.CUSTOMER_SECRET}`).toString("base64")}`;
  const acquire = await axios.post(
    `https://api.agora.io/v1/apps/${process.env.appID}/cloud_recording/acquire`,
    {
      cname: req.body.channel,
      uid: req.body.uid,
      clientRequest: {
        resourceExpiredHour: 24,
      },
    },
    { headers: { Authorization } }
  );

  res.send(acquire.data);
});

Request body:

{
  "channel": "Jo6m9E20E02m9yE5maNk",
  "uid": "45687"
}

Response:

{
  "resourceId": "Etkl6g-zSB7EpP-Da1zN63gS7Jv-butkhmOpECJ68ZYw7z0iOrTlzlXAP4r8gVDYIi9_bR13V6J4Eh8a4DJoKu2_FYpouhmjGOOynn5o8AQRYx3bWiVGyf936LGG-YHvYGhF9Coz_uqO5E0SHRlYQj9WMCAQsxBMMU5RvTS0MMtAO_8UcoQmGMO4pm5b4u6K2ejA8e6-JlV_dCaEadkIa-07RCAhPspjIUEQEcNJsQ_UKP5fVnXIl1OLMfimaDUt7JVDMGJ_z7dnOc01G43FkKFBSJEMzYZ25V2099i0UzewVFzO91j2rx91RGMnTN7g"
}

Acquire Request & Response

Start recording

Now, let's add a POST request handler for a new endpoint called '/start' to start the cloud recording.

app.post("/start", (req, res) => {
  // Start Cloud Recording Here
});

You need to request this endpoint https://api.agora.io/v1/apps/{appID}/cloud_recording/resourceid/{resourceID}/mode/{mode}/start to start the recording.

The endpoint URL must contain the appID, the resourceID (from the previous step), and the mode of recording.

There are two modes of recording:

  • Individual mode: Records the audio and video as separate files for each UID in a channel.

  • Composite mode: Generates a single mixed audio and video file for all UIDs in a channel.

In the body of the request, we should specify the UID, the channel ID, authentication token (if app certificate is enabled for your application), and configurations like recordingConfig, storageConfig, and recordingFileConfig.

Recording File Config: This will define the configurations for the recorded files.

  • avFileType: The format of the recorded files. avFileType can only take ["hls"], setting the recorded files to M3U8 and TS formats.

Recording Config:

  • Max Idle Time: Cloud recording automatically stops recording and leaves the channel when there is no user in the channel after a period (in seconds) set by this parameter. The value range is from 5 to 2^32-1.

  • Stream Types: The type of media stream to record.

    • 0: Audio streams only.

    • 1: Video streams only.

    • 2: Both audio and video streams.

  • Channel Type: The channel profile.

    • 0: Communication Channel (Audio Call/ Video Call).

    • 1: Live Broadcast Channel.

  • Transcoding Config: The video transcoding configuration. You cannot set this parameter in individual recording mode.

    • height: In pixels, should not exceed 1920. width * height should not exceed 1920 * 1080.

    • width: In pixels, should not exceed 1920. width * height should not exceed 1920 * 1080.

    • bitrate: The video bitrate.

    • fps: The frame rate.

    • backgroundColor: RGB Hex Value, The background color of the canvas.

    • mixedVideoLayout: 0: Floating Layout, 1: Best Fit Layout, 2: Vertical Layout. You can learn more about recording layouts in the recording layout documentation.

Storage Config:

  • Vendor: The third-party cloud storage vendor.

    • 0: Qiniu Cloud

    • 1: Amazon S3

    • 2: Alibaba Cloud

    • 3: Tencent Cloud

    • 4: Kingsoft Cloud

  • Region: The regional information specified by your cloud storage.

  • Bucket: The bucket ID from your cloud storage where you want to save your recorded files.

  • Access Key: The access key to your cloud storage.

  • Secret Key: The secret key of your cloud storage.

  • File Name Prefix: An array of strings to set the path of the recorded files in the cloud storage.

Refer to the documentation to learn more about the parameters that you need to pass for storage configuration.

Let's write the POST request to Agora to start the cloud recording. Use environment variables to store the third-party cloud storage credentials and configurations.

app.post("/start", async (req, res) => {
  const Authorization = `Basic ${Buffer.from(`${process.env.CUSTOMERID}:${process.env.CUSTOMER_SECRET}`).toString("base64")}`;
  const appID = process.env.appID;
  const resource = req.body.resource;
  const mode = req.body.mode;

  const start = await axios.post(
    `https://api.agora.io/v1/apps/${appID}/cloud_recording/resourceid/${resource}/mode/${mode}/start`,
    {
      cname: req.body.channel,
      uid: req.body.uid,
      clientRequest: {
        recordingConfig: {
          maxIdleTime: 30,
          streamTypes: 2,
          channelType: 0,
          videoStreamType: 0,
          transcodingConfig: {
            height: 640,
            width: 360,
            bitrate: 500,
            fps: 15,
            mixedVideoLayout: 1,
            backgroundColor: "#FFFFFF",
          },
        },
        recordingFileConfig: {
          avFileType: ["hls"],
        },
        storageConfig: {
          vendor: 1,
          region: 2,
          bucket: process.env.bucket,
          accessKey: process.env.accessKey,
          secretKey: process.env.secretKey,
          fileNamePrefix: ["directory1", "directory2"],
        },
      },
    },
    { headers: { Authorization } }
  );

  res.send(start.data);
});

If the request is successful, the response will contain the recording ID (sid) and the resource ID. We need the recording ID to query, updateLayout, or stop the recording.

Request body:

{
  "channel": "Jo6m9E20E02m9yE5maNk",
  "uid": "45687",
  "mode": "mix",
  "resource": "Etkl6g-zSB7EpP-Da1zN63gS7Jv-butkhmOpECJ68ZYw7z0iOrTlzlXAP4r8gVDYIi9_bR13V6J4Eh8a4DJoKu2_FYpouhmjGOOynn5o8AQRYx3bWiVGyf936LGG-YHvYGhF9Coz_uqO5E0SHRlYQj9WMCAQsxBMMU5RvTS0MMtAO_8UcoQmGMO4pm5b4u6K2ejA8e6-JlV_dCaEadkIa-07RCAhPspjIUEQEcNJsQ_UKP5fVnXIl1OLMfimaDUt7JVDMGJ_z7dnOc01G43FkKFBSJEMzYZ25V2099i0UzewVFzO91j2rx91RGMnTN7g"
}

Response:

{
  "resourceId": "Etkl6g-zSB7EpP-Da1zN63gS7Jv-butkhmOpECJ68ZYw7z0iOrTlzlXAP4r8gVDYIi9_bR13V6J4Eh8a4DJoKu2_FYpouhmjGOOynn5o8AQRYx3bWiVGyf936LGG-YHvYGhF9Coz_uqO5E0SHRlYQj9WMCAQsxBMMU5RvTS0MMtAO_8UcoQmGMO4pm5b4u6K2ejA8e6-JlV_dCaEadkIa-07RCAhPspjIUEQEcNJsQ_UKP5fVnXIl1OLMfimaDUt7JVDMGJ_z7dnOc01G43FkKFBSJEMzYZ25V2099i0UzewVFzO91j2rx91RGMnTN7g",
  "sid": "c87831d3914285db6c102e8a4015d308"
}

Start Request & Reponse

Stop recording

Now, Let's add a POST request handler for a new endpoint called '/stop' to stop the cloud recording.

app.post("/stop", (req, res) => {
  // Stop Cloud Recording Here
});

You need to send a POST request to this endpoint https://api.agora.io/v1/apps/{appid}/cloud_recording/resourceid/{resourceid}/sid/{sid}/mode/{mode}/stop to stop the recording.

The endpoint URL must contain the appID, the resourceID, the sid (recording ID), and the mode of recording.

In the request body, we should specify the UID, the channel ID, and an empty clientRequest object. If the request is successful, the endpoint will respond with the resource ID, the SID, and the details about the recording status.

app.post("/stop", async (req, res) => {
  const Authorization = `Basic ${Buffer.from(`${process.env.CUSTOMERID}:${process.env.CUSTOMER_SECRET}`).toString("base64")}`;
  const appID = process.env.appID;
  const resource = req.body.resource;
  const sid = req.body.sid;
  const mode = req.body.mode;

  const stop = await axios.post(
    `https://api.agora.io/v1/apps/${appID}/cloud_recording/resourceid/${resource}/sid/${sid}/mode/${mode}/stop`,
    {
      cname: req.body.channel,
      uid: req.body.uid,
      clientRequest: {},
    },
    { headers: { Authorization } }
  );
  res.send(stop.data);
});

The response will contain an object called serverResponse. It'll contain the list of files, that is an array of objects containing the details about the files and the uploading status of these files.

The uploading status can either be,

  • uploaded: All the recorded files are uploaded to the third-party cloud storage.

  • backuped: Some of the recorded files fail to upload to the third-party cloud storage and upload to Agora Cloud Backup instead. Agora Cloud Backup automatically uploads these files to your cloud storage.

  • unknown: Unknown status.

Request body:

{
  "channel": "Jo6m9E20E02m9yE5maNk",
  "uid": "45687",
  "mode": "mix",
  "sid": "c87831d3914285db6c102e8a4015d308",
  "resource": "Etkl6g-zSB7EpP-Da1zN63gS7Jv-butkhmOpECJ68ZYw7z0iOrTlzlXAP4r8gVDYIi9_bR13V6J4Eh8a4DJoKu2_FYpouhmjGOOynn5o8AQRYx3bWiVGyf936LGG-YHvYGhF9Coz_uqO5E0SHRlYQj9WMCAQsxBMMU5RvTS0MMtAO_8UcoQmGMO4pm5b4u6K2ejA8e6-JlV_dCaEadkIa-07RCAhPspjIUEQEcNJsQ_UKP5fVnXIl1OLMfimaDUt7JVDMGJ_z7dnOc01G43FkKFBSJEMzYZ25V2099i0UzewVFzO91j2rx91RGMnTN7g"
}

Response:

{
  "resourceId": "Etkl6g-zSB7EpP-Da1zN63gS7Jv-butkhmOpECJ68ZYw7z0iOrTlzlXAP4r8gVDYIi9_bR13V6J4Eh8a4DJoKu2_FYpouhmjGOOynn5o8AQRYx3bWiVGyf936LGG-YHvYGhF9Coz_uqO5E0SHRlYQj9WMCAQsxBMMU5RvTS0MMtAO_8UcoQmGMO4pm5b4u6K2ejA8e6-JlV_dCaEadkIa-07RCAhPspjIUEQEcNJsQ_UKP5fVnXIl1OLMfimaDUt7JVDMGJ_z7dnOc01G43FkKFBSJEMzYZ25V2099i0UzewVFzO91j2rx91RGMnTN7g",
  "sid": "c87831d3914285db6c102e8a4015d308",
  "serverResponse":{
    "fileListMode": "json",
    "fileList": [
    {
      "filename": "M6ETnKVtPbAY892ffaj3.m3u8",
      "trackType": "audio_and_video",
      "uid": "fb2b6760-c2d8-48f6-b61a-066bd632b691",
      "mixedAllUser": true,
      "isPlayable": true,
      "sliceStartTime": 160786677
    },
    {
      "filename": "hlvM26hvtnXjj62fAkMc.m3u8",
      "trackType": "audio_and_video",
      "uid": "6dfdbe0e-2eb7-44c5-8b0c-af414fb2dc8f",
      "mixedAllUser": true,
      "isPlayable": true,
      "sliceStartTime": 1607866792
    }
    ],
    "uploadingStatus": "uploaded"
  }
}

Let's Recap

  1. We learned about cloud recording, on-premise recording, and the differences between them.

  2. We enabled cloud recording from the project management console.

  3. We acquired the customer ID and the customer secret from the project management console.

  4. We set up a simple Express server.

  5. We added a POST request handler to acquire the resource ID for the recording session.

  6. We added a POST request handler to start the recording session with the resource ID. We learned about all the parameters that we need to pass to start the recording.

  7. We added a POST request handler to stop the recording session.

Congratulations, :partying_face: You did it.

Thanks for reading!

Peer Review Contributions by: Adrian Murage

Published on: Jan 6, 2021
Updated on: Jul 15, 2024
CTA

Cloudzilla is FREE for React and Node.js projects

Deploy GitHub projects across every major cloud in under 3 minutes. No credit card required.
Get Started for Free