Integrate the SDK
This page explains how to set up the environment and integrate the On-Premise Recording SDK.
Recording audio and video in a channel using the On-Premise Recording SDK works by adding a special user to the Video SDK channel. This special user captures the audio and video from the channel, transcodes it, and stores it on your Linux server. To achieve this:
- Integrate the On-Premise Recording SDK on your Linux server.
- Ensure that the On-Premise Recording SDK uses the same App ID as the Video SDK to join the channel you want to record.
Integrate the On-Premise Recording SDK into your Linux server, not your client app. To record audio and video without deploying a Linux server, use Agora Cloud Recording.
Prerequisites
Hardware and network requirements
The following table lists the basic requirements for installing the On-Premise Recording SDK:
Cloud Hosting Configuration
The recording concurrency test results, presented in this section, were conducted on the following cloud hosting configuration:
- AWS: Intel(R) Xeon(R) Platinum 8124M CPU @ 3.00 GHz
- 16 Virtual Core CPU, 32 GB RAM
- Disk I/O: 412 MB/s
Tests were performed under the following conditions:
- Each channel had two users/hosts. The resolution and frame rate of each channel were set to 320 × 240 and 15 fps, respectively.
- The resolution, frame rate, and bitrate of the recorded files in composite recording mode were set to 640 × 480, 15 fps, and 500 Kbps, respectively. The audio bitrate of the recorded files in composite recording mode was set to 48 Kbps.
Test results:
| Channel Profile | Recording Mode | Performance |
|---|---|---|
| Live Broadcast | Audio + Video Individual recording |
When recording 215 channels simultaneously, the CPU usage was about 75%. We recommend recording up to 200 channels simultaneously. |
| Audio + Video Composite recording |
When recording 70 channels simultaneously, the CPU usage was about 75%. We recommend recording up to 60 channels simultaneously. | |
| Audio only Composite recording |
When recording 300 channels simultaneously, the CPU usage was about 75%. | |
| Communication | Audio + Video Individual recording |
When recording 210 channels simultaneously, the CPU usage was about 75%. We recommend recording up to 200 channels simultaneously. |
| Audio + Video Composite recording |
When recording 60 channels simultaneously, the CPU usage was about 75%. |
The test results are for reference only. We recommend setting up and testing your cloud hosting based on your specific recording requirements.
Next steps
The Agora On-Premise Recording SDK is integrated. Choose either of the following ways to start recording:
- Record using the command line: Record a call by using the command line with Agora's demo.
- Record using the API: Record a call by calling the APIs.
The command line and API methods implement the same recording functions.