本接口用于开始旁路推流任务。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rtc:StartStreamingOut | create | *App acs:rtc:*:{#accountId}:app/{#AppId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 应用 ID,通过控制台创建和查询,仅支持传单个 ID。 | eo85**** |
ChannelId | string | 是 | 已存在的频道 ID,仅支持传单个 ID。 | testid |
TemplateId | string | 是 | 模版 ID。 | 567 |
Url | string | 是 | 直播推流地址,仅支持传单个地址。该地址不可多个任务同时使用。 | rtmp://example.com/live/stream |
TaskId | string | 否 | 本次旁路推流的任务 ID,仅支持传单个 ID。由大小写字母、数字、下划线、短划线(-)组成,最大 55 字节,不填,则由系统自动生成。 | 123 |
CropMode | integer | 否 | 裁剪方式。取值:
| 2 |
Panes | array<object> | 否 | 单元格设置。 | eo85**** |
object | 否 | |||
SourceType | string | 否 | 单元格媒体类型。取值:
| video |
PaneId | string | 是 | 窗格 ID,从 0 开始。 | 0 |
Source | string | 否 | 单元格媒体源。可指定 userId,如需指定特定用户类型。可使用通配符配置,支持以下类型。
| 22 |
PaneCropMode | integer | 否 | 裁剪方式。取值:
| 2 |
Images | array<object> | 否 | 窗格局部图片水印。 | |
object | 否 | |||
Url | string | 是 | 对应的图片内容在推流期间不支持更新。 | https://aliyun.com/123xxx.jpg |
Alpha | double | 否 | 透明度。 | 0.9 |
PaneImageCropMode | integer | 否 | 裁剪方式。取值:
| 2 |
X | double | 是 | 横坐标。 | 0.2 |
Y | double | 是 | 纵坐标。 | 0.3 |
Width | double | 是 | 宽。 | 0.2 |
Height | double | 是 | 高。 | 0.2 |
Layer | integer | 否 | z 轴层级。 | 0 |
Texts | array<object> | 否 | 窗格局部文字水印。 | |
object | 否 | |||
Texture | string | 是 | 水印内容。 | 文字水印 |
FontSize | integer | 否 | 字体大小。 | 36 |
Alpha | double | 否 | 水印透明度。 | 0.9 |
FontColor | object | 否 | 字体颜色。 | |
R | integer | 否 | R。 | 255 |
G | integer | 否 | G。 | 255 |
B | integer | 否 | B。 | 255 |
Font | integer | 否 | 字体。
| 0 |
X | double | 是 | 横坐标。 | 0.2 |
Y | double | 是 | 纵坐标。 | 0.2 |
Layer | integer | 否 | z 轴层级。 | 0 |
HasBox | boolean | 否 | 是否需要矩形框。 | |
BoxColor | object | 否 | 矩形框颜色。 | |
R | integer | 否 | R。 | 255 |
G | integer | 否 | G。 | 255 |
B | integer | 否 | B。 | 255 |
BoxAlpha | double | 否 | 矩形框透明度。 | 0.6 |
BoxBorderw | integer | 否 | 矩形框线宽。 | 5 |
Backgrounds | array<object> | 否 | 背景图片。 | |
object | 否 | |||
Url | string | 是 | 图片地址。 | https://aliyun.com/123.jpg |
Alpha | double | 否 | 透明度。 | 0.9 |
BackgroundCropMode | integer | 否 | 裁剪方式。取值:
| 2 |
X | double | 是 | 横坐标。 | 0.2 |
Y | double | 是 | 纵坐标。 | 0.2 |
Width | double | 是 | 宽。 | 0.2 |
Height | double | 是 | 高。 | 0.2 |
Layer | integer | 否 | z 轴层级。 | 0 |
Images | array<object> | 否 | 全局图片水印。 | |
object | 否 | |||
Url | string | 是 | 图片地址。对应的图片内容在推流期间不支持更新 | https://aliyun.com/123xxx.jpg |
Alpha | double | 否 | 透明度。 | 0.9 |
ImageCropMode | integer | 否 | 裁剪方式。取值:
| 2 |
X | double | 是 | 横坐标。 | 0.2 |
Y | double | 是 | 纵坐标。 | 0.2 |
Width | double | 是 | 宽。 | 0.2 |
Height | double | 是 | 高。 | 0.2 |
Layer | integer | 否 | z 轴层级。 | 0 |
Texts | array<object> | 否 | 全局文字水印。 | |
object | 否 | |||
Texture | string | 是 | 水印内容。 | 文字水印 |
FontSize | integer | 否 | 字体大小。 | 36 |
Alpha | double | 否 | 水印透明度。 | 0.1 |
FontColor | object | 否 | 字体颜色。 | |
R | integer | 否 | R。 | 255 |
G | integer | 否 | G。 | 255 |
B | integer | 否 | B。 | 255 |
Font | integer | 否 | 字体。
| 0 |
X | double | 是 | 横坐标。 | 0.2 |
Y | double | 是 | 纵坐标。 | 0.2 |
Layer | integer | 否 | z 轴层级。 | 0 |
HasBox | boolean | 否 | 是否需要矩形框。 | |
BoxColor | object | 否 | 矩形框颜色。 | |
R | integer | 否 | R。 | 255 |
G | integer | 否 | G。 | 255 |
B | integer | 否 | B。 | 255 |
BoxAlpha | double | 否 | 矩形框透明度。 | 0.6 |
BoxBorderw | integer | 否 | 矩形框线宽。 | 5 |
ClockWidgets | array<object> | 否 | 全局时钟水印。 | |
object | 否 | |||
Zone | integer | 否 | 时区。 | 8 |
FontSize | integer | 否 | 时钟字体大小。 | 30 |
Alpha | double | 否 | 透明度。 | 0.9 |
FontColor | object | 否 | 字体颜色。 | |
R | integer | 否 | R。 | 255 |
G | integer | 否 | G。 | 255 |
B | integer | 否 | B。 | 255 |
Font | integer | 否 | 字体。
| 0 |
X | double | 是 | 横坐标。 | 0.2 |
Y | double | 是 | 纵坐标。 | 0.2 |
Layer | integer | 否 | z 轴层级。 | 0 |
HasBox | boolean | 否 | 是否需要矩形框。 | |
BoxColor | object | 否 | 矩形框颜色。 | |
R | integer | 否 | R。 | 255 |
G | integer | 否 | G。 | 255 |
B | integer | 否 | B。 | 255 |
BoxAlpha | double | 否 | 矩形框透明度。 | 0.6 |
BoxBorderw | integer | 否 | 矩形框线宽。 | 5 |
RegionColor | object | 否 | 全局框格底色 | |
R | integer | 否 | R。 | 255 |
G | integer | 否 | G。 | 255 |
B | integer | 否 | B。 | 255 |
LayoutSpecifiedUsers | object | 否 | 布局生成用户指定列表,包括黑/白名单两种。 白名单,指定订阅房间里哪些用户视频流。
黑名单,指定不订阅房间里哪些用户视频流。
| |
Type | string | 是 | 用户名单类型,黑名单:black,白名单:white。 | |
Ids | array | 是 | 指定用户 ID 列表。 | |
string | 是 | 具体用户 ID。 |
局部图片水印数量、全局图片水印数量和全局背景图数量的总和不能超过 16。
返回参数
示例
正常返回示例
JSON
格式
{
"TaskId": "123",
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CF8"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-12-16 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-11-06 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-03-20 | API 内部配置变更,不影响调用 | 查看变更详情 |