tencent cloud

1. API Description

Domain name for API request: trtc.tencentcloudapi.com.

API description

This API is used to start an on-cloud recording task. It records the audio and video streams in a room and saves them to the specified cloud storage. You can use this API to record the streams in a room separately, or you can mix the streams first and then record the mixed stream.

You can use this API to perform the following operations:

• Specify the anchors whose streams you want or do not want to record by using the RecordParams parameter
• Specify the storage service you want to save recording files to by using the StorageParams parameter
• Specify transcoding settings for mixed-stream recording, including video resolution, video bitrate, frame rate, and audio quality, by using MixTranscodeParams
• Specify the layout of different videos in mixed-stream recording mode or select an auto-arranged layout template

Key concepts

• Single-stream recording: Record the audio and video of each subscribed user (UserId) in a room and save the recording files (M3U8/TS) to the cloud
• Mixed-stream recording: Mix the audios and videos of subscribed users (UserId) in a room, record the mixed stream, and save the recording files (M3U8/TS) to the cloud

A maximum of 20 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 Starting an on-cloud recording task

This example shows you how to start on-cloud recording in room 3560 under the application whose SDKAppID is 1234.

The timeout period for recording is one minute.
The recording mode is mixed-stream recording.
The type of the streams recorded are audio and video.
The streams of all anchors in the room are subscribed.
The recording file is saved to Tencent Cloud with the prefix directory1/directory2/.
The resolution of the recorded video is 360 x 640, the frame rate is 15 fps, and the bitrate is 500,000 bps. The default background color is used.
The grid layout template is used.

Input Example

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudRecording
<Common request parameters>

{
    "StorageParams": {
        "CloudStorage": {
            "Vendor": 0,
            "Region": "xx",
            "Bucket": "xx",
            "FileNamePrefix": [
                "directory1",
                "directory2"
            ],
            "SecretKey": "xx",
            "AccessKey": "xx"
        }
    },
    "UserSig": "xx",
    "UserId": "xx",
    "RecordParams": {
        "MaxIdleTime": 60,
        "StreamType": 0,
        "RecordMode": 2
    },
    "RoomIdType": 1,
    "MixTranscodeParams": {
        "VideoParams": {
            "Width": 360,
            "BitRate": 500000,
            "Fps": 15,
            "Height": 640,
            "Gop": 10
        }
    },
    "SdkAppId": 1234,
    "RoomId": "3560"
}

Output Example

{
  "Response": {
    "TaskId": "5df46eb2-8e4b-490e-9c3c-dbd3b84faefc",
    "RequestId": "71993312-6ab8-4768-9124-118e0a20c45f"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.