Skip to main content

Quickstart

This article describes how to use the On-Premise Recording SDK to record real-time audio and video.

Understand the tech

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.

info

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

Before you begin, complete the following steps and ensure your environment meets the required specifications:

  • Create an Agora project in the Agora Console and obtain an App ID and a temporary token.
  • Implement a Video SDK project that includes basic audio and video interaction.

Server hardware requirements:

  • CPU: 8 cores, 1.8 GHz
  • Memory: At least 4 GB (recommended)

Server software requirements:

  • Operating system: Ubuntu 18.04 or later, or CentOS 7.0 or later
  • CPU architecture: arm64 or x86-64
  • glibc: version 2.18 or later
  • gcc: version 4.8 or later

Network requirements:

  • The server is connected to the public internet and has a public IP address.

  • The server allows access to the following domains:

    • *.agora.io
    • *.agoralab.co

Project setup

This section shows how to integrate the On-Premise Recording SDK into your app.

Implement On-Premise Recording

This section shows how to implement On-Premise recording in your app, step by step.

The following figure illustrates the essential steps:

Quickstart sequence diagram

Test the project

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

API reference