创建播放器配置

最近更新时间:2024-03-12 02:01:39

我的收藏

1. 接口描述

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

该 API 已经不再维护,新版播放器签名不再使用播放器配置模板,详细请参考 播放器签名
创建播放器配置,数量上限:100。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateSuperPlayerConfig。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
Name String 播放器配置名称,长度限制:64 个字符。只允许出现 [0-9a-zA-Z] 及 - 字符(如 testABC-123),同一个用户该名称唯一。
示例值:test
SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
示例值:1490012345
AudioVideoType String 播放的音视频类型,可选值:
  • AdaptiveDynamicStream:自适应码流输出;
  • Transcode:转码输出;
  • Original:原始音视频。

  • 默认为 AdaptiveDynamicStream。
    示例值:AdaptiveDynamicStream
    DrmSwitch String 播放 DRM 保护的自适应码流开关:
  • ON:开启,表示仅播放 DRM 保护的自适应码流输出;
  • OFF:关闭,表示播放未加密的自适应码流输出。

  • 默认为 OFF。
    当 AudioVideoType 为 AdaptiveDynamicStream 时,此参数有效。
    示例值:OFF
    AdaptiveDynamicStreamingDefinition Integer 允许输出的未加密的自适应码流模板 ID。

    当 AudioVideoType 为 AdaptiveDynamicStream 并且 DrmSwitch 为 OFF 时,此参数为必填。
    示例值:10
    DrmStreamingsInfo DrmStreamingsInfo 允许输出的 DRM 自适应码流模板内容。

    当 AudioVideoType 为 AdaptiveDynamicStream 并且 DrmSwitch 为 ON 时,此参数为必填。
    TranscodeDefinition Integer 允许输出的转码模板 ID。

    当 AudioVideoType 为 Transcode 时必填。
    示例值:0
    ImageSpriteDefinition Integer 允许输出的雪碧图模板 ID。
    示例值:0
    ResolutionNames.N Array of ResolutionNameInfo 播放器对于不同分辨率的子流展示名字,不填或者填空数组则使用默认配置:
  • MinEdgeLength:240,Name:流畅;
  • MinEdgeLength:480,Name:标清;
  • MinEdgeLength:720,Name:高清;
  • MinEdgeLength:1080,Name:全高清;
  • MinEdgeLength:1440,Name:2K;
  • MinEdgeLength:2160,Name:4K;
  • MinEdgeLength:4320,Name:8K。
  • Domain String 播放时使用的域名。不填或者填 Default,表示使用默认分发配置中的域名。
    示例值:Default
    Scheme String 播放时使用的 Scheme。不填或者填 Default,表示使用默认分发配置中的 Scheme。其他可选值:
  • HTTP;
  • HTTPS。

  • 示例值:HTTPS
    Comment String 模板描述信息,长度限制:256 个字符。
    示例值:test config

    3. 输出参数

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

    4. 示例

    示例1 创建播放器配置

    创建播放器配置

    输入示例

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateSuperPlayerConfig
    <公共请求参数>
    
    {
        "AdaptiveDynamicStreamingDefinition": "10",
        "Name": "test"
    }

    输出示例

    {
        "Response": {
            "RequestId": "12ae8d8e-dce3-4151-1d4b-5594145287e1"
        }
    }

    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.InvalidVodUser 没有开通点播业务。
    InternalError 内部错误。
    InvalidParameterValue 参数取值错误。
    LimitExceeded 超过配额限制。
    UnauthorizedOperation 未授权操作。