Agora On-premise Recording Overview

Last updated 2021/02/18 07:08:33

If you do not want to prepare server resources, Agora recommends using Agora Cloud Recording, which enables you to record voice/video calls and interactive streaming on your cloud storage through RESTful APIs.

The Agora On-premise Recording SDK is a component provided by Agora to record and save voice calls, video calls, and interactive live streaming on your server. The Agora On-premise Recording SDK is compatible with the Agora Native SDK v1.7.0+ and the Agora Web SDK v1.12.0+.

For example, a user can either attend an online course at the time of the course or watch the recorded course later; made possible by the Agora On-premise Recording SDK being deployed at the server by the online course provider.

Functions

The Agora On-premise Recording SDK enables you to record high-quality voice or video calls made via the Agora RTC SDK. See the following table for details.

Function	Description
Record specified media type	You can specify the media type to record: Record only audio. Record only video. Record both audio and video.
Choose recording mode	You can choose one of the following recording modes: Individual Recording: The SDK generates one audio and/or video file for each UID. Composite Recording: Generates a single mixed audio and video file for all UIDs in a channel, or mixes the audio of all UIDs in the channel into an audio file and the video of all UIDs into a video file. You can also set the audio and video profile of the recording file.
Set Video Layout	In composite recording mode, you can: Set the size and position of the region for each user in the layout. Set the background images associated with each user. Set the background image of the canvas.
Record specified UIDs	You can specify the UIDs you want to record.
Get the raw data	You can get the raw data in the following formats: Raw audio data in AAC or PCM formats. Raw video data in H.264 or YUV formats.
Capture Screenshots	In individual recording mode, you can get one recording file and multiple screenshots in JPEG format for each UID, or only get screenshots in JPEG format. In composite recording mode, you can get a video file in MP4 format and multiple screenshots in JPEG format.
Watermark	In composite recording mode, you can add watermarks to the video, including text, timestamp, and image watermarks.
Use the proxy	You can configure the proxy server or Use Cloud Proxy to connect to Agora's services through a firewall.
Record dual streams	If you enable the dual-stream mode in the Agora RTC SDK, the Agora On-premise Recording SDK allows you to record the following streams: Only record the high-video stream. Only record the low-video stream.
Record encrypted channels	You can record a channel that is encrypted.

Applications

The Agora On-premise Recording SDK can be used in the following scenarios:

Industry	Applications
Online Education	One-to-one and one-to-many online courses. The Agora On-premise Recording SDK provides high-quality voice and video recordings. Students can replay recordings for review. Students can make up for missed courses at their convenience.
Live Streaming	The replay of interactive live streaming highlights. Captures screenshots. Detects sexually explicit content.
Financial Industry	When conducting financial management, account registration, and face-to-face businesses, the financial industry can use audio and video recordings for record keeping and archival purposes.
Customer Service/Call Centers	The recordings can be used for service quality evaluations.
Remote Health Care	Recordings of remote diagnoses and online medical consultations enable patients to acquire medical resources in remote or inaccessible areas. Can be used as references for subsequent treatments.

Features

The Agora On-premise Recording SDK consists of the following features:

Feature	Description
High Reliability	The Agora On-premise Recording SDK supports cluster deployment, dynamic capacity expansion, and high availability services.
High Security	Provides end-to-end security mechanisms for video calls, data transmission, data storage, and so on. For details, see Information Security Policy.
Compatibility	Supports CentOS 6.5+ x64 and Ubuntu 14.04+ x64 operating systems.
Ease of Use	Simple implementation and easy to learn. You can get started quickly, flexibly deploy recording services, and easily record on mobile and web pages.
Flexibility	By flexibly combining various functions of the Agora On-premise Recording SDK, you can seamlessly apply the SDK to multiple scenarios to achieve better service.

Compatibility with the Agora SDKs

The recording SDK supports:

Recording communication that uses the Native SDK.
Recording communication that uses the Web SDK.
Recording communication that uses both the Native SDK and the Web SDK.

The On-premise Recording SDK is compatible with the following Agora SDK versions:

Agora SDK	Compatible versions
Agora Native SDK	v1.7.0 or later
Agora Web SDK	v1.12.0 or later

If any user in the channel uses an Agora SDK which is not compatible with the Agora On-premise Recording SDK, recording fails for the whole channel.

References

Integrate the SDK and Record a Call on how to deploy and use the Agora On-premise Recording SDK, manage, play, and protect recorded files.
API Reference lists the API methods of the Agora On-premise Recording SDK.
The Agora Linux Server Recording sample app enables recording on your Linux server.
Recording Concurrency introduces the concurrency of on-premise recording.

Is this page helpful?

Yes