获取转码模板列表

最近更新时间:2019-05-09 19:16:34

1. 接口描述

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

根据转码模板唯一标识,获取转码模板详情列表。返回结果包含符合条件的所有用户自定义模板及系统预置转码模板

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

2. 输入参数

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

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

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的记录总数。
    TranscodeTemplateSet Array of TranscodeTemplate 转码模板详情列表。
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取转码模板

    输入示例

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

    输出示例

    {
      "Response": {
        "TotalCount": 1,
        "TranscodeTemplateSet": [
          {
            "Definition": 1008,
            "Container": "mp4",
            "Name": "模板1",
            "Comment": null,
            "Type": 0,
            "RemoveVideo": 0,
            "RemoveAudio": 0,
            "VideoTemplate": {
              "Codec": "libx264",
              "Fps": 24,
              "Bitrate": 256,
              "ResolutionAdaptive": "open",
              "Width": 0,
              "Height": 0,
              "MinGop": 1,
              "MaxGop": 10,
              "VideoProfile": "high",
              "ColorSpace": "yuv420p"
            },
            "AudioTemplate": {
              "Codec": "libfdk_aac",
              "Bitrate": 48,
              "SampleRate": 48000,
              "AudioChannel": 2,
              "AudioProfile": "aac_lc"
            },
            "CreateTime": "2018-10-01T10:00:00Z",
            "UpdateTime": "2018-10-01T10:00:00Z"
          }
        ],
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameterValue.ContainerType 参数值错误:ContainerType。
    InvalidParameterValue.Definitions 参数错误:Definitions。
    InvalidParameterValue.Limit 参数错误:Limit。
    InvalidParameterValue.Type Type 参数值错误。