Cloud Recording
  • Introduction
  • Release notes
  • Getting started
  • Guides
    • Single-stream recording
    • Mixed-stream recording
    • Set mixed-stream layout
    • Multi-sector recording (Whiteboard)
    • Capture screenshots
  • API reference
    • API overview
    • Accessing Server APIs
    • Start recording
    • Stop recording
    • Update the mixed-stream layout
    • Update the whiteboard
    • Query recording status
    • Query the recording task list
    • Pause recording
    • Resume recording
    • Callback of the recording status
    • API testing with Postman
  • Error codes

Start a cloud recording

Last updated:2022-03-31 18:40

With ZEGOCLOUD's Cloud Recording, you can start cloud recording by sending a Server API request without integrating an SDK.
This document describes how to start cloud recording, query cloud recording status, stop cloud recording, and more by sending a simple Server API request.

Basic process

The following diagram shows the complete process of implementing a cloud recording:

Enable cloud recording

Before you begin, make sure you complete the following:

  • Build an App that has integrated the ZEGOCLOUD voice and video call SDK.
  • Enable a third-party cloud storage service. The currently supported third-party cloud storage service providers are: Amazon S3, Alibaba Cloud OSS, Tencent Cloud COS, Qiniu Cloud Kodo, Alibaba Cloud VOD (MP4, FLV).

Cloud Recording is not enabled by default, you will need to contact ZEGOCLOUD Technical Support to enable it first.

Start cloud recording

To start cloud recording, use the StartRecord method to get the room ID to join a specific room. After calling this method successfully, you can get the taskID (UID) from the response body.

And you will need to use this taskID as a request parameter for the subsequent requests. For details, see Accessing Server APIs.

Query recording status

During recording, call the DescribeRecordStatus method multiple times. After calling this method successfully, you can get the current recording status and the address to be uploaded from the response body.

Update mixed-stream layout

To update the layout of the mixed streams during video recording, call the UpdateLayout method multiple times. For more details, see Set stream mixing layout.

Update the whiteboard

To update the Whiteboard ID during recording, call the UpdateWhiteboard method multiple times. For more details, see Whiteboard Recording.

Stop cloud recording

To stop the cloud recording, call the StopRecord method.

Manage recorded files

Upload recorded files

After the cloud recording task is completed, the recording files will be uploaded to the pre-designated third-party cloud storage. To check the uploading details, call the DescribeRecordStatus method.

  • FileUrl: Returns the URL of the recorded files to be uploaded.
  • Status: Returns the uploading status of the recorded files.
  • VideoId: Vod returns the VideoId of the recorded files.

After uploading the recording files, the cloud recording sends a callback to the callback URL that is specified when activating the service.

Manage recorded file names

The recording file name contains information such as StreamId, timestamp of start recording. For more details, refer to the OutputFileRule parameter of the StartRecord method.

Page Directory