云直播
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > 云直播 > API 文档 > 直播拉流相关接口 > 更新直播拉流任务

更新直播拉流任务

最近更新时间：2024-04-22 01:20:07

我的收藏

本页目录：

1. 接口描述

接口请求域名： live.tencentcloudapi.com 。

更新直播拉流任务。

  1. 不支持修改拉流源类型，如需更换，请创建新任务。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ModifyLivePullStreamTask。
Version 是 String 公共参数，本接口取值：2018-08-01。
Region 是 String 公共参数，详见产品支持的 地域列表。
TaskId 是 String 任务Id。
示例值：123
Operator 是 String 操作人姓名。
示例值：yourname
SourceUrls.N 否 Array of String 拉流源url列表。
SourceType为直播（PullLivePushLive）只可以填1个，
SourceType为点播（PullVodPushLive）可以填多个，上限30个。
示例值：["rtmp://your.domainname.com/live/stream1\n"]
StartTime 否 String 开始时间。
使用UTC格式时间，
例如：2019-01-08T10:00:00Z。
注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。
示例值：2020-04-16T11:02:00Z
EndTime 否 String 结束时间，注意：
1. 结束时间必须大于开始时间；
2. 结束时间和开始时间必须大于当前时间；
3. 结束时间 和 开始时间 间隔必须小于七天。
使用UTC格式时间，
例如：2019-01-08T10:00:00Z。
注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。
示例值：2020-04-17T12:02:00Z
VodLoopTimes 否 Integer 点播拉流转推循环次数。
-1：无限循环，直到任务结束。
0：不循环。
>0：具体循环次数。次数和时间以先结束的为准。
注意：拉流源为点播，该配置生效。
示例值：-1
VodRefreshType 否 String 点播更新SourceUrls后的播放方式：
ImmediateNewSource：立即从更新的拉流源开始播放；
ContinueBreakPoint：从上次断流url源的断点处继续，结束后再使用新的拉流源。
注意：拉流源为点播，该配置生效。
示例值：ImmediateNewSource
Status 否 String 任务状态：
enable - 启用，
pause - 暂停。
示例值：enable
CallbackEvents.N 否 Array of String 选择需要回调的事件（不填则回调全部）：
TaskStart：任务启动回调，
TaskExit：任务停止回调，
VodSourceFileStart：从点播源文件开始拉流回调，
VodSourceFileFinish：从点播源文件拉流结束回调，
ResetTaskConfig：任务更新回调。
CallbackUrl 否 String 自定义回调地址。
相关事件会回调到该地址。
示例值：http://callback.com/interface
FileIndex 否 Integer 指定播放文件索引。
注意： 从1开始，不大于SourceUrls中文件个数。
示例值：0
OffsetTime 否 Integer 指定播放文件偏移。
注意：
1. 单位：秒，配合FileIndex使用。
示例值：0
SpecifyTaskId 否 String 指定任务 ID 修改任务。

注意：该自定义任务 ID 只有在创建任务时指定了，才可在此处修改时使用。否则请使用系统返回的任务 ID。
示例值：1234567
ToUrl 否 String 目标 Url。
换目标地址，会断流重推到新地址。
示例值：rtmp://5000.livepush.myqcloud.com/live/vin1333?txSecret=6e9797ce
Comment 否 String 任务备注。
示例值：备注
BackupSourceType 否 String 备源的类型：
PullLivePushLive -直播，
PullVodPushLive -点播。
注意：
1. 仅当主源类型为直播源时，备源才会生效。
2. 将该参数置为空，则可将任务去除备源信息。
3. 主直播源拉流中断时，自动使用备源进行拉流。
4. 如果备源为点播文件时，则每次轮播完点播文件就检查主源是否恢复，如果主源恢复则自动切回到主源，否则继续拉备源。
示例值：PullLivePushLive
BackupSourceUrl 否 String 备源 URL。
只允许填一个备源 URL
示例值：http://5000.liveplay.myqcloud.com/live/backup.flv?txSecret=4d8e
WatermarkList.N 否 Array of PullPushWatermarkInfo 水印信息列表。
注意：
1. 最多支持4个不同位置的水印。
2. 水印图片 URL 请使用合法外网可访问地址。
3. 支持的水印图片格式：png，jpg等。
4. 轮播任务修改水印后，轮播到下一个文件时新水印生效。
5. 直播源任务修改水印后，水印立即生效。
6. 清除水印时，需携带该水印列表参数，内容为空数组。
7. 暂不支持动图水印。
VodLocalMode 否 Integer 点播源是否启用本地推流模式，默认0，不启用。
0 - 不启用。
1 - 启用。
注意：启用本地模式后，会将源列表中的 MP4 文件进行本地下载，优先使用本地已下载文件进行推流，提高点播源推流稳定性。使用本地下载文件推流时，会产生增值费用。
示例值：0
BackupToUrl 否 String 新的目标地址。传空值，则取消该地址的推流。
传入新值，则替换原有地址。
BackupVodUrl 否 String 点播垫片文件地址。注意：用于在主源拉不到时自动兜底到垫片文件，切到垫片文件后，每次播完垫片会尝试拉主源，如果主源恢复则自动切回主源。可根据需要的轮询检查时长来传入对应时长的垫片文件。
示例值：http://vod.com/file/pad.mp4

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

修改直播拉流任务。

输入示例

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

{
    "Operator": "yourname",
    "EndTime": "2020-04-17T12:02:00Z",
    "StartTime": "2020-04-16T11:02:00Z",
    "TaskId": "123",
    "SourceUrls": [
        "rtmp://your.domainname.com/live/stream1"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.CallOtherSvrFailed 调用内部服务失败。
InvalidParameter 参数错误。
InvalidParameter.InvalidBackupToUrl 无效的备用推流地址。
InvalidParameter.InvalidCallbackUrl 回调地址不规范。
InvalidParameter.InvalidSourceUrl 源地址不规范。
InvalidParameter.InvalidTaskTime 任务时间超出限制。
InvalidParameter.InvalidToUrl 目标地址不规范。
InvalidParameter.InvalidWatermark 水印参数有误。
InvalidParameter.TaskNotExist 任务不存在。
InvalidParameter.ToUrlNoPermission 外部地址无权限。
MissingParameter 缺少参数错误。
ResourceNotFound.ForbidService 用户被禁用。
ResourceNotFound.FreezeService 用户服务被冻结。
ResourceNotFound.StopService 账号停服，请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService 用户主动停服。
ResourceNotFound.UserNotExist 用户未注册直播。
中国站