Skip to main content

On-Premise Recording

The Agora On-Premise Recording SDK is a recording component developed by Agora for audio and video calls and live broadcasts. Through simple operation methods, it helps developers quickly and flexibly deploy recording services to record audio and video calls or live broadcasts and generate recording files in MP4 format.

With the recording function, you can save the content of voice calls, video calls, and live broadcasts, and make it available for later viewing. For example, learners can review course recordings at their convenience or catch up on lessons they missed after attending live online classes.

The SDK works with Video SDK and is compatible with the Agora RTC Native and framework SDKs (version 1.7.0 or higher) and the Agora RTC Web SDK (version 1.12.0 or higher).

info

The Agora On-Premise Recording SDK requires deployment on Linux servers with self-managed maintenance. If you prefer not to deploy Linux servers and want to implement recording through RESTful APIs, use Agora Cloud Recording.

Start building with

SDK quickstart

Customize your experience from the start with our flexible Video SDK.

Authentication

API reference

Samples

Product Features

Flexible recording modes

Choose between single-stream recording (separate MP4 files for each UID) or converged recording (combined audio/video in one MP4 file) to meet different use cases.

Comprehensive media support

Record audio only, video only, or both simultaneously. Compatible with Agora RTC Native/Framework SDK (v1.7.0+) and Web SDK (v1.12.0+).

Advanced layout control

Set custom mixed-stream layouts, specify user screen sizes and positions on video canvas, and configure background images in converged recording mode.

Selective recording

Record specific UIDs in channels and add text watermarks, dynamic timestamp watermarks, or static image watermarks to recorded video files.

Enterprise-grade infrastructure

Deploy on Ubuntu 18.04+ and CentOS 7.0+ with cluster support, proxy server configuration, cloud proxy services, and end-to-end security for encrypted channels.

Local screenshot capture

Capture JPG format screenshots from live streams and save them to specified local paths. Access raw video data in YUV, JPG, and encoded video frame formats.