开启旁路转推

最近更新时间:2025-04-25 02:04:58

我的收藏

1. 接口描述

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

启动一个混流转推任务,将 TRTC 房间的多路音视频流混成一路音视频流,编码后推到直播 CDN 或者回推到 TRTC 房间。也支持不转码直接转推 TRTC 房间的单路流。启动成功后,会返回一个 SdkAppid 维度唯一的任务 Id(TaskId)。您需要保存该 TaskId,后续需要依赖此 TaskId 更新和结束任务。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:StartPublishLiveStream。
Version String 公共参数,本接口取值:2022-03-25。
Region String 公共参数,此参数为可选参数。
WithTranscoding Integer 是否转码,0表示无需转码,1表示需要转码。是否收取转码费是由WithTranscoding参数决定的,WithTranscoding为0,表示旁路转推,不会收取转码费用,WithTranscoding为1,表示混流转推,会收取转码费用。 示例值:1
示例值:0
MaxIdleTime Integer 所有参与混流转推的主播持续离开TRTC房间或切换成观众超过MaxIdleTime的时长,自动停止转推,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。
示例值:20
VideoParams VideoParams 转推视频参数
PublishParams.N Array of PublishParams 转推的URL参数,一个任务最多支持10个推流URL

3. 输出参数

参数名称 类型 描述
TaskId String 用于唯一标识转推任务,由腾讯云服务端生成,后续停止请求需要携带TaskiD参数。
示例值:D0xOlGVRsurq9PRB-Iuak6f-J0ac-asdaafds-8pZgA.
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 启动腾讯云直播单流转推

输入示例

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

{
    "PublishParams": [
        {
            "PublishUrl": "rtmp://live-push-test.tencentcs.com/live/test1?txSecret=abcd1234567890&txTime=679C9784",
            "IsTencentUrl": 1
        }
    ],
    "MaxIdleTime": 20,
    "VideoParams": {
        "Width": 1920,
        "Height": 1080,
        "Fps": 30,
        "BitRate": 1500,
        "Gop": 2,
        "VideoList": [
            {
                "VideoStreamId": 0,
                "Width": 1920,
                "Height": 1080,
                "DeviceId": "geek_gw_2",
                "ProjectId": "m82k5408n675phvb"
            }
        ]
    },
    "WithTranscoding": 1
}

输出示例

{
    "Response": {
        "RequestId": "StartPublishCdnStream-1",
        "TaskId": "D0xOlGVRsurq9PRB-Iuak6f-J0ac-twfB4hQwbFucIB9muIw9pP0FOpOYkgdMNK52kIoPlhHe96RlTGxKzJwUgzjD-8pZgA."
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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