实时互动-工业能源版开始云端录制

1. 接口描述

接口请求域名： trro.tencentcloudapi.com 。

启动云端录制功能，完成房间内的音视频录制，并上传到指定的云存储。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateCloudRecording。
Version	是	String	公共参数，本接口取值：2022-03-25。
Region	否	String	公共参数，此参数为可选参数。
ProjectId	是	String	项目id 示例值：m82k5408n123phvb
DeviceId	是	String	设备id 示例值：trro_dev
VideoStreamId	是	Integer	视频流号示例值：0
CloudStorage	是	CloudStorage	腾讯云对象存储COS以及第三方云存储的账号信息
MaxMediaFileDuration	否	Integer	如果是aac或者mp4文件格式，超过长度限制后，系统会自动拆分视频文件。单位：分钟。默认为1440min（24h），取值范围为1-1440。【单文件限制最大为2G，满足文件大小 >2G 或录制时长度 > 24h任意一个条件，文件都会自动切分】 Hls 格式录制此参数不生效。示例值：1440
OutputFormat	否	Integer	输出文件的格式（存储至COS等第三方存储时有效）。0：输出文件为hls格式。1：输出文件格式为hls+mp4。2：输出文件格式为hls+aac 。3：(默认)输出文件格式为mp4。4：输出文件格式为aac。示例值：3
MaxIdleTime	否	Integer	房间内持续没有主播的状态超过MaxIdleTime的时长，自动停止录制，单位：秒。默认值为 30 秒，该值需大于等于 5秒，且小于等于 86400秒(24小时)。示例值：30 示例值：30

3. 输出参数

参数名称	类型	描述
TaskId	String	云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识，结束录制时会失去意义。任务 ID需要业务保存下来，作为下次针对这个录制任务操作的参数。示例值：D1ls6oRRsqxbnpbSM4EHpghzM46sszgfPsEhxrFucIB9muIw9pP0FOpOYkgdMNK52kIoPlhHXHxd+m5x662qyDsFSh4TZwA.
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 开启云端录制

输入示例

POST / HTTP/1.1
Host: trro.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudRecording
<公共请求参数>

{
    "DeviceId": "dev1",
    "ProjectId": "m82k5408n123phvb",
    "OutputFormat": 3,
    "VideoStreamId": 0,
    "MaxMediaFileDuration": 20,
    "MaxIdleTime": 20,
    "CloudStorage": {
        "Vendor": 0,
        "Bucket": "recording-1304123456",
        "Region": "ap-nanjing",
        "AccessKey": "accesskey-test",
        "SecretKey": "secretkey-test",
        "FileNamePrefix": [
            "2024-12-24",
            "dev1"
        ]
    }
}

输出示例

{
    "Response": {
        "TaskId": "-gCTFWtU7t7DUlo7A8IswFszO9z2O-rbERqJAoK-4pycoZXKjIAAnasdcasdOEycyX4CnzhIm4RAQ..",
        "RequestId": "71993312-6ab8-4768-9124-118e0a20c45f"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。

开始云端录制

本页目录：