文档中心

实时音视频

请输入

转推直播

开始单流转推 StartPushSingleStreamToCDN

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

调用 StartPushSingleStreamToCDN 接口，将房间内指定的一路音视频流推送到 CDN 地址。该功能不对视频进行转码，仅对音频进行转码。

使用说明

前提条件

在使用单流转推功能前，请先在RTC 控制台-功能配置开启转推直播服务。

配置建议

监听回调：可开通回调消息通知，监听事件 TranscodeStarted、TranscodeStopped、TranscodeUpdated、TranscodeStateChange，以实时接收任务启动、停止、文件生成等事件。具体操作，可参见回调消息通知。

视频帧的朝向设置为固定：在移动端开发时，建议通过 setVideoOrientation 接口将采集视频帧的朝向设置为固定。

Android: setVideoOrientation

iOS: setVideoOrientation:

注意事项

请求频率：QPS 不得超过 150。

同一 TaskId 不能同时开启合流转推和单流转推任务。

请求说明

请求方式：POST

请求地址：https://rtc.volcengineapi.com?Action=StartPushSingleStreamToCDN&Version=2023-11-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

Action String 必选示例值：StartPushSingleStreamToCDN

接口名称。当前 API 的名称为 StartPushSingleStreamToCDN。

Version String 必选示例值：2023-11-01

接口版本。当前 API 的版本为 2023-11-01。

Body

AppId String 必选示例值：66****3cf

实时音视频应用的 AppId。可在控制台获取。

BusinessId String 可选示例值：B****3

业务标识，用于区分不同业务。可在控制台获取。

RoomId String 必选示例值：Room1

目标房间的 ID。

TaskId String 必选示例值：Task1

转推任务 ID。由您自定义，用于标识和管理（更新、停止）任务。

命名规范：符合正则表达式 [a-zA-Z0-9_@-.]{1,128}。

唯一性规则：在同一个 AppId 和 RoomId 组合下，TaskId 必须唯一。

任务运行中，使用相同 TaskId 重复调用该接口，系统将返回提示而非报错。

Stream Object 必选示例值：-

指定要转推的流。

UserId String 必选示例值：user1

流所属用户 ID。

StreamType Integer 可选示例值：0

流的类型。支持取值及含义如下：

0：普通音视频流。

1：屏幕流。

默认值为 0。

PushURL String 必选示例值：rtmp://push.example.com/live/stream123

推流地址，用于将音视频推送到指定的 CDN 服务器。支持 RTMP/RTMPS 协议。

Control Object 必选

高级配置。

MediaType Integer 可选示例值：0

全局控制订阅的流的类型，支持的取值如下：

0：音视频。

1：纯音频。

默认值为 0。

MaxIdleTime Integer 可选示例值：180

任务的空闲超时时间，单位为秒。

任务启动后，系统会自动分配一个后端机器人订阅目标流。如果机器人在房间内始终没有订阅到目标流（例如目标用户不在房间或指定的流停止发布），任务就会处于“空闲状态”。空闲时间超过设定值，任务就会自动结束。

取值范围为 [10, 86400]。

默认值为 180。

返回参数

本接口无特有的返回参数。公共返回参数请见返回结构。

其中返回值 Result 仅在请求成功时返回 ok，失败时为空。

请求示例

返回示例

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2026.06.01 15:54:37

这个页面对您有帮助吗？

有用

无用