云直播轮播任务插播文件

1. 接口描述

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

可通过调用该接口，对点播源的直播拉流任务进行插播操作。
注意：

仅支持对有效且运行中的点播源任务进行插播操作。
拉转推插播文件时，事件及回调中的索引均保持为插播前的值。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：InsertTaskTemporaryFiles。
Version	是	String	公共参数，本接口取值：2018-08-01。
Region	否	String	公共参数，本接口不需要传递此参数。
TaskId	是	String	直播拉流任务 ID。示例值：823421
TemporaryFiles.N	是	Array of String	插播文件列表，支持一次性插播多个文件，文件个数最大支持30个。可在轮播过程中追加新的插播文件。示例值：["http://vod.com/path/test.mp4"]
Operator	是	String	操作人名称。示例值：admin
InsertAfterIndex	否	Integer	将文件插在当前轮播序列的指定位置后面。索引序列从1开始。默认为：0，表示播完当前文件立即播放插入文件。注意：索引不要超过当前总文件个数，否则按播完全部文件后再处理插播文件。示例值：0
InsertPriorityType	否	Integer	用于多个文件插播在同一个轮播序号之后时，可指定队列顺序。 0 - 最高优先级队列。默认值。 1 - 中等优先级队列。 2 - 最低优先级队列。场景示例：比如当前播放第2个文件，多个新文件插播在第2个文件之后，播完第二个轮播文件之后，优先播放InsertPriorityType为0的插播队列中的文件，再播放InsertPriorityType为1的插播队列中的文件，最后播放InsertPriorityType为2的插播队列文件。如果插播无队列优先级要求，则无需使用此参数。示例值：2
InsertContext	否	String	插播上下文信息。由用户自定义传入。当播放到使用本此插播请求插入的文件时，在文件播放开始和文件播放结束的回调时，将此上下文信息通过创建任务携带的回调地址回调给用户。注意：如果有关联每个插播文件的信息需要回调时，可将需要回调的信息自行拼接到插播文件URL上，通过回调信息中的URL进行读取使用。示例值：InsertId=492

3. 输出参数

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

4. 示例

示例1 请求示例

输入示例

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

{
    "TaskId": "895451",
    "InsertAfterIndex": 0,
    "TemporaryFiles": [
        "http://vod.com/path/test.mp4"
    ],
    "Operator": "admin"
}

输出示例

{
    "Response": {
        "RequestId": "1047d0dc-6dc8-4898-a7f3-03726a822b0e"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InvalidParameter.TaskNotExist	任务不存在。
ResourceNotFound.ForbidService	用户被禁用。
ResourceNotFound.FreezeService	用户服务被冻结。
ResourceNotFound.StopService	账号停服，请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService	用户主动停服。

轮播任务插播文件

本页目录：