最近更新时间:2023.09.25 21:09:57
首次发布时间:2022.01.17 10:33:21
创建一个拉流转推任务,支持从点播拉流与从直播拉流两种方式。
说明
该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版创建拉流转推任务接口。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreatePullToPushTask | 接口名称。当前 API 的名称为 CreatePullToPushTask 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Title | String | 否 | task001 | 标题,支持中英文字符、数字,最大长度为 10 个字符 |
StartTime | Integer | 是 | 1640891476 | 开始时间,Unix 时间戳,单位为 s |
EndTime | Integer | 是 | 1640841476 | 结束时间,Unix 时间戳(秒) |
CallbackURL | String | 否 | http://example.mtime.cn/live/example/callbackapi | 回调地址,最大长度为 2000 个字符 |
Type | Integer | 是 |
| 拉流来源类型。支持以下 2 种取值。
|
CycleMode | Integer | 否 |
| 循环模式。当
|
PlayTimes | Integer | 否 | 3 | 点播文件循环播放次数。当 "CycleMode":0 时,为必选参数。 |
DstAddr | String | 否 | rtmp://example.mtime.cn/Video/2022/02/04/mp4/190204084208765161.mp4 | 推流地址 |
Domain | String | 否 | example.mtime.cn | 推流域名,DstAddr 为空时必传;反之,则该参数不生效 |
App | String | 否 | live | 推流 App 名称,DstAddr 为空时必传;反之,则该参数不生效 |
Stream | String | 否 | stream-123 | 转推的推流流名,DstAddr 为空时必传;反之,则该参数不生效 |
SrcAddr | String | 否 |
| 拉流地址,与 |
SrcAddrS | Array of String | 否 | ["https://pull.example.com/live/stream-123"] | 拉流地址列表,与 SrcAddr 二选一。最多支持传入 20 个拉流地址。 |
Watermark | Object of Watermark | 否 | 水印信息 | |
PreDownload | Integer | 否 |
| 是否开启点播预热,仅对点播地址生效。
|
OffsetS | Array of Float | 否 | 点播文件启播时间偏移值, 单位秒;数量与 SrcAddrS 列表数量相等。 | |
ContinueStrategy | Integer | 否 |
| 续播策略,支持以下配置项。
|
Offset | Float | 否 | 30 | 点播文件启播时间偏移值,仅当 SrcAddr 不为空时生效。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Picture | String | 是 |
| 水印图片字符串,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片 Data URL 格式为:
|
RelativePosX | Float | 是 | 0.1 | 水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1) |
RelativePosY | Float | 是 | 0.1 | 垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1) |
Ratio | Float | 是 | 0.1 | 水印宽度,占直播原始画面宽度百分比,支持精度,小数点后两位 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TaskId | String | 8fde6aa0281d9f6e15e6059a6e242365 | 任务 ID,任务的唯一标识 |
POST https://live.volcengineapi.com?Action=CreatePullToPushTask&Version=2020-08-01 { "Type":0, "DstAddr": "rtmp://example.mtime.cn/Video/2022/02/04/mp4/190204084208765161.mp4", "EndTime": 1640881476, "SrcAddr": "http://example.mtime.cn/Video/2003/02/04/mp4/190204084208765161.mp4", "StartTime": 1640841476, "Title": "sutest001", "CallbackURL":"http://example.mtime.cn/live/test/callbackapi" }
{ "ResponseMetadata": { "RequestId": "202112311457430101742350380352BCB2", "Action": "CreatePullToPushTask", "Version": "2020-08-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "TaskId": "8fde6aa0281d*******9a6e242365" } }
访问公共错误码获取详细信息。