含 UI 集成方案

有奖征文|投稿上云技术实践,赢取价值5000元大奖> HOT

1. 接口描述

接口请求域名: trtc.tencentcloudapi.com 。

成功开启录制后,可以使用此接口来更新录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。更新操作是全量覆盖,并不是增量更新的模式,也就是说每次更新都需要携带全量的信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyCloudRecording。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai 。
SdkAppId Integer TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
TaskId String 录制任务的唯一Id,在启动录制成功后会返回。
MixLayoutParams MixLayoutParams 需要更新的混流的布局参数。
SubscribeStreamUserIds SubscribeStreamUserIds 指定订阅流白名单或者黑名单。

3. 输出参数

参数名称 类型 描述
TaskId String 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 更新云端录制

更新SdkAppId 为 1234 TaskId 为xx 的云端录制,设置视频流订阅白名单123,456,设置音频流订阅白名单123,456。设置自定义布局模式。

输入示例

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

{
    "SubscribeStreamUserIds": {
        "SubscribeVideoUserIds": [
            "123",
            "456"
        ],
        "SubscribeAudioUserIds": [
            "123",
            "456"
        ]
    },
    "TaskId": "xx",
    "SdkAppId": 1234,
    "MixLayoutParams": {
        "MixLayoutMode": 4,
        "MixLayoutList": [
            {
                "Top": 100,
                "UserId": "123",
                "Height": 100,
                "Width": 100,
                "Left": 100
            },
            {
                "Top": 200,
                "UserId": "456",
                "Height": 100,
                "Width": 100,
                "Left": 200
            }
        ]
    }
}

输出示例

{
    "Response": {
        "TaskId": "5df46eb2-8e4b-490e-9c3c-dbd3b84faefc",
        "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。

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnRealNameAuthenticated 未完成实名认证,不允许此操作。
AuthFailure.UnauthorizedOperation CAM鉴权失败。
AuthFailure.UnsupportedOperation 不支持该操作。
FailedOperation 操作失败。
FailedOperation.CRUnsupportMethod 云端录制方法不支持。
InternalError.CRInternalError 云端录制内部服务错误。
InvalidParameter.OutOfRange 参数超出范围。
MissingParameter.RoomId 缺少RoomId参数。
MissingParameter.SdkAppId 缺少SdkAppId参数。
MissingParameter.TaskId 缺少TaskId参数。
MissingParameter.UserId 缺少UserId参数。
ResourceNotFound 资源不存在。
目录