- 应用管理
- 布局
- 回调管理
- 频道管理
- 云端录制
- 旁路推流
- 纪要
- 数据服务
- RTC（旧版）
接口说明
使用说明
本接口用于开始在线频道旁路推流任务。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。
请求参数
| 字段名称 | 字段详情 |
|---|---|
AppIdstring | 应用 ID，通过控制台创建和查询，仅支持传单个 ID。 示例值:eo85**** |
ChannelIdstring | 已存在的频道 ID，仅支持传单个 ID。 示例值:testid参考取值来源: DescribeRtcChannelList |
TemplateIdstring | 模版 ID。 示例值:567正则:^[\w.-]+$参考取值来源: AddRecordTemplate UpdateRecordTemplate DescribeRecordTemplates CreateAppRecordTemplate ModifyAppStreamingOutTemplate |
Urlstring | 直播推流地址，仅支持传单个地址。该地址不可多个任务同时使用。 示例值:rtmp://example.com/live/stream字符长度 <= 1024字符长度 >= 1 |
TaskIdstring | 本次旁路推流的任务 ID，仅支持传单个 ID。由大小写字母、数字、下划线、短划线（-）组成，最大 55 字节，不填，则由系统自动生成。 示例值:123正则:^[0-9a-zA-Z_-]+$字符长度 <= 55字符长度 >= 1 |
CropModeinteger<int32> | 裁剪方式。取值：展开详情 示例值:2枚举值:123 |
ReservePaneForNoCameraUserboolean | 未推摄像头流用户窗格占位。展开详情 |
ShowDefaultBackgroundOnMuteboolean | mute 时是否显示窗格默认底图。展开详情 |
StartWithoutChannelboolean | 是否允许频道不存在时开启任务。展开详情 |
StartWithoutChannelWaitTimeinteger<int32> | 当 StartWithoutChannel 参数为 true 的时候，设置该值才有意义，表示房间未开启时，任务等待时长，单位为秒，区间限制为[30,120]。 示例值:30 |
Panesarray<object> | 单元格设置。 示例值:eo85****子级条数 <= 16 |
Backgroundsarray<object> | 背景图片。 子级条数 <= 3 |
Imagesarray<object> | 全局图片水印。 示例值:30子级条数 <= 3 |
Textsarray<object> | 全局文字水印。 子级条数 <= 3 |
ClockWidgetsarray<object> | 全局时钟水印。 子级条数 <= 3 |
RegionColorobject | 全局框格底色 |
LayoutSpecifiedUsersobject | 布局生成用户指定列表，包括黑/白名单两种。展开详情 |
请求说明
局部图片水印数量、局部背景图片水印、全局图片水印数量和全局背景图数量的总和不能超过 16。
绘制视频 -> 绘制图片 -> 绘制文字
视频、图片、文字是完全分开的，从整个画面来看 文字优先级 > 图片 > 视频
-
绘制视频： 根据客户定义的布局对视频画面进行布局
a. 宫格中的图片和全局图片的 layer 统一排列。
b. layer 0 位于最底层，layer 越大越位于上方，layer 的取值范围为[0,100] 。
-
绘制图片 图片包括用户自定义的 png/jpg 图片。
a. 根据用户配置宽高、位置、透明度等信息进行绘制。
b. layer 0 位于最底层，layer 越大越位于上方，layer 的取值范围为[0,100] 。
-
绘制文字 文字分为 3 个类型 ： 区域文字 全局文字和时间戳文字 。
a. 同一类型文字根据 layer 顺序绘制，layer 0 位于最底层，layer 越大越位于上方，layer 的取值范围为[0,100] 。
b. 不同类型文字优先级为 ： 时间戳文字 > 全局文字 > 区域文字 。处于重叠位置时，优先级较低的将被覆盖。
重叠部分的显示：
- 重叠部分，如果没有特别配置，高优先级将覆盖低优先级 。
- 低优先级内容如果不想被高优先级内容覆盖，可以设置高优先级内容的透明度属性为 0。
返回参数
| 字段名称 | 字段详情 |
|---|---|
TaskIdstring | 本次旁路推流的任务 ID。 示例值:123 |
RequestIdstring | 请求 ID。 示例值:16A96B9A-F203-4EC5-8E43-CB92E68F4CF8 |