更新转推任务

最近更新时间:2024-07-31 02:17:56

我的收藏

1. 接口描述

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

接口说明:
成功发起混流转推后,可以使用此接口来更新任务。仅在任务进行时有效,任务退出后更新将会返回错误。更新操作为增量更新模式。
注意:为了保障推流的稳定性,更新不支持任务在纯音频、音视频、纯视频之间进行切换。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpdatePublishCdnStream。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。
SdkAppId Integer TRTC的SdkAppId,和转推的房间所对应的SdkAppId相同。
示例值:1400188366
TaskId String 唯一标识转推任务。
示例值:xxxxxxxx
SequenceNumber Integer 客户保证同一个任务,每次更新请求中的SequenceNumber递增,防止请求乱序。
示例值:2
WithTranscoding Integer 是否转码,0表示无需转码,1表示需要转码。
示例值:1
AudioParams McuAudioParams 更新相关参数,只支持更新参与混音的主播列表参数,不支持更新Codec、采样率、码率和声道数。不填表示不更新此参数。
示例值:AudioParams
VideoParams McuVideoParams 更新视频相关参数,转码时支持更新除编码类型之外的编码参数,视频布局参数,背景图片和背景颜色参数,水印参数。不填表示不更新此参数。
示例值:VideoParams
SingleSubscribeParams SingleSubscribeParams 更新单流转推的用户上行参数,仅在非转码时有效。不填表示不更新此参数。
示例值:SingleSubscribeParams
PublishCdnParams.N Array of McuPublishCdnParam 更新转推的CDN参数。不填表示不更新此参数。
示例值:PublishCdnParams
SeiParams McuSeiParams 混流SEI参数
示例值:SeiParams
FeedBackRoomParams.N Array of McuFeedBackRoomParams 回推房间信息
示例值:FeedBackRoomParams

3. 输出参数

参数名称 类型 描述
TaskId String 转推任务唯一的String Id
示例值:xxxx
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 更新转推参数

输入示例

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

{
    "SdkAppId": 1400188366,
    "TaskId": "-m97l2ZU7kOlV5cTRMoU6yoGp2nDYkzbJ13EC4K-4pycoZXVv+XVrNoUXQ8++8Z2PwUlAQ..",
    "SequenceNumber": 20,
    "WithTranscoding": 1,
    "PublishCdnParams": [
        {
            "IsTencentCdn": 1,
            "PublishCdnUrl": "rtmp://3891.livepush.myqcloud.com/live/trtc_publishcdn_test2?bizid=3891&txSecret=23aeb6ec16fd275af0d00a447b2282f7&txTime=62635BDE"
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "71993312-6ab8-4768-9124-118e0a20c45f",
        "TaskId": "xxxx"
    }
}

示例2 更新混音和布局参数

更新为混主播Trtc_User_0和Trtc_User_3的音视频。

输入示例

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

{
    "SdkAppId": 1400188366,
    "TaskId": "-m97l2ZU7kOlV5cTRMoU6yoGp2nDYkzbJ13EC4K-4pycoZXVv+XVrNoUXQ8++8Z2PwUlAQ..",
    "SequenceNumber": 20,
    "WithTranscoding": 1,
    "AudioParams": {
        "SubscribeAudioList": [
            {
                "UserInfo": {
                    "RoomId": "48111",
                    "RoomIdType": 0,
                    "UserId": "Trtc_User_0"
                }
            },
            {
                "UserInfo": {
                    "RoomId": "48111",
                    "RoomIdType": 0,
                    "UserId": "Trtc_User_3"
                }
            }
        ]
    },
    "VideoParams": {
        "LayoutParams": {
            "MixLayoutMode": 4,
            "MixLayoutList": [
                {
                    "UserMediaStream": {
                        "UserInfo": {
                            "RoomId": "48111",
                            "RoomIdType": 0,
                            "UserId": "Trtc_User_3"
                        },
                        "StreamType": 0
                    },
                    "ImageWidth": 640,
                    "ImageHeight": 720,
                    "LocationX": 0,
                    "LocationY": 0,
                    "ZOrder": 0,
                    "RenderMode": 0
                },
                {
                    "UserMediaStream": {
                        "UserInfo": {
                            "RoomId": "48111",
                            "RoomIdType": 0,
                            "UserId": "Trtc_User_0"
                        },
                        "StreamType": 0
                    },
                    "ImageWidth": 640,
                    "ImageHeight": 720,
                    "LocationX": 640,
                    "LocationY": 360,
                    "ZOrder": 0,
                    "RenderMode": 0
                }
            ]
        }
    }
}

输出示例

{
    "Response": {
        "RequestId": "71993312-6ab8-4768-9124-118e0a20c45f",
        "TaskId": "xxxx"
    }
}

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.RequestOutdated 请求过期。
FailedOperation.TaskFinished 调用接口时任务已结束。
InternalError 内部错误。
InvalidParameter 参数错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
UnsupportedOperation 操作不支持。