获取转自适应码流模板列表

最近更新时间:2019-09-20 16:16:46

1. 接口描述

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

查询转自适应码流模板,支持根据条件,分页查询。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAdaptiveDynamicStreamingTemplates
Version String 公共参数,本接口取值:2018-07-17
Region String 公共参数,本接口不需要传递此参数。
Definitions.N Array of Integer 转自适应码流模板唯一标识过滤条件,数组长度限制:100。
Offset Integer 分页偏移量,默认值:0。
Limit Integer 返回记录条数,默认值:10,最大值:100。
Type String 模板类型过滤条件,可选值:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。
  • SubAppId Integer 点播子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的记录总数。
    AdaptiveDynamicStreamingTemplateSet Array of AdaptiveDynamicStreamingTemplate 转自适应码流模板详情列表。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询转自适应码流模板列表

    输入示例

    https://vod.tencentcloudapi.com/?Action=DescribeAdaptiveDynamicStreamingTemplates
    &Definitions.0=10001
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "TotalCount": 1,
        "AdaptiveDynamicStreamingTemplateSet": [
          {
            "Definition": 1001,
            "Type": "Custom",
            "Name": "转自适应码流模板1",
            "Comment": "",
            "CreateTime": "2018-10-01T10:00:00Z",
            "UpdateTime": "2018-10-01T10:00:00Z",
            "PackageType": "hls",
            "DrmType": "",
            "VideoTrackTemplateSet": [
              {
                "Definition": 1001,
                "Container": "mp4",
                "Type": "Custom",
                "Name": "视频轨模板1",
                "Comment": "",
                "CreateTime": "2018-10-01T10:00:00Z",
                "UpdateTime": "2018-10-01T10:00:00Z",
                "Codec": "libx264",
                "Fps": 25,
                "Bitrate": 128,
                "ResolutionAdaptive": "close",
                "Width": 1080,
                "Height": 960,
                "FillType": "black"
              }
            ],
            "AudioTrackTemplateSet": [
              {
                "Definition": 1001,
                "Container": "m4a",
                "Type": "Custom",
                "Name": "音频轨模板1",
                "Comment": "",
                "CreateTime": "2018-10-01T10:00:00Z",
                "UpdateTime": "2018-10-01T10:00:00Z",
                "Codec": "libfdk_aac",
                "Bitrate": 128,
                "SampleRate": 44100,
                "AudioChannel": 2
              }
            ],
            "DisableHigherVideoBitrate": 1,
            "DisableHigherVideoResolution": 0
          }
        ],
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameterValue.Definitions 参数错误:Definitions。
    InvalidParameterValue.Limit 参数错误:Limit。
    InvalidParameterValue.Type Type 参数值错误。
    UnauthorizedOperation 未授权操作。