Agora Cloud Recording is an add-on service to record and save voice calls, video calls, and interactive streaming on your cloud storage. Compared with Agora On-premise Recording, Agora Cloud Recording is more efficient and convenient as it does not require deploying Linux servers.
Agora Cloud Recording is compatible with the following SDKs:
This release includes the following new feature and API changes:
Adds web page recording mode. In this mode, the content and audio of a specified web page are recorded in a single file.
webas a value for
modein the request URL for web page recording.
sceneas a new parameter in the
acquiremethod for setting the application of the cloud recording resources.
"web_recorder_service"as an extension service in the
extensionServiceConfigparameter of the
This release improved the stability and performance of the recording service, and fixed the following issues:
This release adds the following new feature and API changes:
In composite recording mode, you can now upload recorded files to ApsaraVideo for VoD for further processing.
extensionServiceConfigparameter for specifying the configurations of ApsaraVideo for VoD.
vod_triggeredcallbacks, which report the status of uploading recorded files to ApsaraVideo for VoD.
This release provides a more flexible UID subscription feature, enabling you to set up a whitelist or blacklist for audio and video subscriptions. You can also update the subscription lists during the cloud recording. For details, see Set up subscription lists.
This release adds the
session_failover event, which occurs when the high availability mechanism is enabled and reports the new recording UID.
unSubscribeAudioUidsparameters for setting up subscription blacklists.
updatefor updating the subscription lists during the cloud recording.
This release adds support for Kingsoft Cloud.
Cloud Recording now supports taking screenshots of the video streams in individual recording mode. See Capture Screenshots for details.
This release improved the availability of the cloud recording service. When a server is disconnected or when the process is killed, the cloud recording automatically switches to a new server to resume the service. See Fault processing when a cloud recording server is disconnected or the process killed for more information.
acquire method, adds the
resourceExpiredHour parameter for setting the time limit for all cloud recording method calls.
session_exit event, which reports the exit status of the cloud recording service.
You can now use the
query method to get the names of the recorded files immediately after the recording starts.
This release supports Tencent Cloud as one of the third-party cloud storages.
The RESTful API adds individual recording mode, which supports recording the audio and video of each UID separately. See Individual Recording for details. Meanwhile, Agora provides the Audio & Video File Merging script, which you can use to merge the audio and video files generated in individual mode. See Merge Audio and Video Files for details.
The RESTful API adds the
subscribeVideoUids parameters, which allow you to record only specified UIDs.
The RESTful API adds the
fileNamePrefix parameter, which allows you to specify the directory where you want to store the recorded files in the third-party cloud storage.
The RESTful API callback service adds the
recorder_video_stream_state_changed events to report the time when the state of the audio or video stream changes, as well as the corresponding UID.
Agora provides the Format Converter script, which you can use to convert between multiple file formats, such as TS, MP3, and MP4. See Convert File Format for details.
You can achieve synchronized playback between the recorded files and other stream files, such as online whiteboards, courseware, and messages, by using the timestamp when the recording starts. You can get the timestamp by using the RESTful API callback service, or by parsing the M3U8 file. See Synchronized Playback for details.
When an error occurs, you receive the error message in the HTTP response body, instead of just the error code. See Agora Cloud Recording RESTful API for detailed information about the error codes.
When uploading fails after you use the wrong
key values of the third-party cloud storage, Agora Cloud Recording returns an error instead of uploading the recorded files to Agora Cloud Backup.
The RESTful API adds a customized layout for the recording video. See Set Video Layout for details.
You can set the
mixedVideoLayout parameter as
3 and set the regions for each user in the
layoutConfig parameter when starting a recording.
You can update the layout anytime during the recording by the
The RESTful API adds the
backgroundColor parameter to support customized background colors for the video layout.
To get the accurate starting time of a recording, the RESTful API provides the Unix timestamp of when the first slicing starts in the response of the
query method. The RESTful API callback service adds the
recorder_slice_start event to report the time when the first slicing starts and the time when the last recording fails.
Optimizes the verification of whether
resourceId corresponds with
cname when calling the RESTful API.
Fixed minor issues in the default video layout (floating layout).
This release supports RESTful APIs. With the RESTful APIs, you can use Agora Cloud Recording through HTTP requests without integrating the SDK.
See the following documents for details:
This is the first release of Agora Cloud Recording with the following functions: