Recording SDK Release Notes

Overview

The Agora Recording SDK for Linux (Recording SDK for short) records communication and live broadcast contents based on Agora Native SDK or/and Agora Web SDK.

Obtain the Package

You can download the latest Recording SDK at downloads or contact sales-us@agora.io.

Compability

This component package is compatible with the following SDKs:

SDK Description
Agora Native SDK The Recording SDK is compatible with all-platform Agora Native SDK(v1.7.0 or later) . If any participant in the channel uses v1.6 Agora SDK, the whole channel cannot record anything.
Agora Web SDK The Recording SDK is compatible with Agora Web SDK(v1.12.0 or later) [1]

footnotes

[1]Currently we only tested based on Agora Web SDK v1.12.0, thus it is recommended that you use Agora Web SDK 1.12.0.

Known Issue and Limitation

  • When you record using an Android client, the image is turned upside-down when you switch from the front-facing camera to the rear one.
  • If the user calls leaveChannel() in the channel to stop recording, then the recording file ends with a period of silence which is decided by the idleLimitSec field set for config when calling joinChannel() in Recording API.
  • The recorded audio or video files are not encrypted, to be compliant with HIPPA, you need to encrypt the disk with a disk encryption tool, for example, cryptsetup.

v1.1 (Released July 25, 2017)

New Function:

  • Added a new function of supporting recording at the Web client side. For details, refer to Manage the Recording Files
  • Added a new function of supporting real-time video mixing function. For details, refer to Recording API
  • Added a set of callback functions. For details, refer to Recording API
  • Modified the file format after the transcoding. For details, refer to Play the Recording Files
  • Enabled the function of configuring the UDP port flexibly

Bug Fix:

  • Fixed the occasional issue of wrong timestamp
  • Fixed the occasional transcoding failure
  • Fixed the occasional issue of being unable to playback the VLC files

v1.0.1 (Released June 27, 2017)

Fixed a crash when you set the channel profile of the recording as Live Broadcast.

v1.0.0 (Released June 15, 2017)

This is the first release of the Recording SDK with the following functions provided:

  • Communication and Live Broadcast scenario
  • Recording audio and video of all participants in a channel
  • Recording audio and video of all participants in multiple channels simultaneously
  • Recording audio of all participants in a channel or in multiple channels simultaneously
  • Recording an encrypted channel if the application has integrated Agora built-in encryption

For more details, refer to the following documents:

Document Description
Recording FAQs It provides the most frenquently asked questions and answers to different recording solutions and the issues you might encouter when using the Recording SDK
Recording Quickstart It provides the instruction on how to compile and run the sample code provided by Agora for you to understand the recording function
Recording SDK Guide It provides the detailed procedure on how to integrate the recording SDK, how to manage the recording file and etc
Recording API It provides the detailed explanation on the API required for this function