创建轮播播单

最近更新时间:2024-08-19 02:31:53

我的收藏

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

该接口用于创建轮播播单,数量上限:100。
轮播播单的每个文件可以指定源文件,也可以指定某个转码文件。
指定的文件必须是hls格式,所有的播单文件最好保持相同的码率和分辨率。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateRoundPlay。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
StartTime String 启播时间,格式按照 ISO 8601标准表示,详见 ISO 日期格式说明
示例值:2018-12-01T00:00:00+08:00
RoundPlaylist.N Array of RoundPlayListItemInfo 轮播列表。
  • 数组长度限制:100。
  • SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
    示例值:1490012345
    Name String 轮播播单名称,长度限制:64 个字符。
    示例值:MyRound
    Desc String 轮播播单描述信息,长度限制:256 个字符。
    示例值:my first round
    PlayBackMode String 播放模式,可选值:
  • Loop:循环播放播单;
  • Linear:单次播放,播单播放完停止播放。

  • 默认值:Loop。
    示例值:Loop

    3. 输出参数

    参数名称 类型 描述
    RoundPlayId String 轮播播单唯一标识。
    示例值:100
    Url String 轮播播放地址。
    示例值:domain/round-play/bffb15f07530b57bc1aabb01fac74bca/playlist.m3u8
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 创建轮播播单

    新建一个轮播播单,可以指定轮播列表。

    输入示例

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateRoundPlay
    <公共请求参数>
    
    {
        "StartTime": "2022-06-01T00:00:00+08:00",
        "RoundPlaylist": [
            {
                "FileId": "528xxx5487985271487",
                "AudioVideoType": "Transcode",
                "Definition": 100210
            }
        ]
    }

    输出示例

    {
        "Response": {
            "RoundPlayId": "bffb15f07530b57bc1aabb01fac74bca",
            "Url": "http://domain/round-play/bffb15f07530b57bc1aabb01fac74bca/playlist.m3u8",
            "RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    InvalidParameter 参数错误。
    InvalidParameterValue.RoundPlaylist RoundPlaylist 参数长度错误。
    LimitExceeded.PlayList 播放列表长度太大。
    LimitExceeded.RoundPlays 超过播单总数限制。
    LimitExceeded.RunningRoundPlays 运行中的播单超过最大数量。