获取转码模板列表

最近更新时间:2024-10-12 13:27:16

我的收藏

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTranscodeTemplates。
Version String 公共参数,本接口取值:2019-06-12。
Region String 公共参数,本接口不需要传递此参数。
Definitions.N Array of Integer 转码模板唯一标识过滤条件,数组长度限制:100。
示例值:[10]
Type String 模板类型过滤条件,可选值:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。

  • 示例值:“”
    ContainerType String 封装格式过滤条件,可选值:
  • Video:视频格式,可以同时包含视频流和音频流的封装格式板;
  • PureAudio:纯音频格式,只能包含音频流的封装格式。

  • 示例值:“”
    TEHDType String (建议使用TranscodeType代替)极速高清过滤条件,用于过滤普通转码或极速高清转码模板,可选值:
  • Common:普通转码模板;
  • TEHD:极速高清模板。

  • 示例值:“”
    Offset Integer 分页偏移量,默认值:0。
    示例值:0
    Limit Integer 返回记录条数,默认值:10,最大值:100。
    示例值:10
    TranscodeType String 模板类型(替换旧版本 TEHDType),可选值:
  • Common:普通转码模板;
  • TEHD:视频极速高清,老的类型(建议使用 TEHD-100) 。
  • TEHD-100:视频极速高清
  • TEHD-200:音频极速高清
  • Enhance:音视频增强模板。

  • 默认空,不限制类型。

    示例值:“”
    Name String 转码模板标识过滤条件,长度限制:64 个字符。
    示例值:""

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的记录总数。
    示例值:1
    TranscodeTemplateSet Array of TranscodeTemplate 转码模板详情列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取转码模板

    获取转码模板

    输入示例

    POST / HTTP/1.1
    Host: mps.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeTranscodeTemplates
    <公共请求参数>
    
    {
        "Definitions": [
            "10"
        ]
    }

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "TranscodeTemplateSet": [
                {
                    "Definition": "abc",
                    "Container": "abc",
                    "Name": "abc",
                    "Comment": "abc",
                    "Type": "abc",
                    "RemoveVideo": 0,
                    "RemoveAudio": 0,
                    "VideoTemplate": {
                        "Codec": "abc",
                        "Fps": 0,
                        "Bitrate": 0,
                        "ResolutionAdaptive": "abc",
                        "Width": 1,
                        "Height": 1,
                        "Gop": 1,
                        "FillType": "abc",
                        "Vcrf": 1,
                        "HlsTime": 1,
                        "SegmentType": 0
                    },
                    "AudioTemplate": {
                        "Codec": "abc",
                        "Bitrate": 0,
                        "SampleRate": 1,
                        "AudioChannel": 0
                    },
                    "TEHDConfig": {
                        "Type": "abc",
                        "MaxVideoBitrate": 0
                    },
                    "ContainerType": "abc",
                    "CreateTime": "abc",
                    "UpdateTime": "abc",
                    "EnhanceConfig": {
                        "VideoEnhance": {
                            "FrameRate": {
                                "Switch": "abc",
                                "Fps": 1
                            },
                            "SuperResolution": {
                                "Switch": "abc",
                                "Type": "abc",
                                "Size": 0
                            },
                            "Hdr": {
                                "Switch": "abc",
                                "Type": "abc"
                            },
                            "Denoise": {
                                "Switch": "abc",
                                "Type": "abc"
                            },
                            "ImageQualityEnhance": {
                                "Switch": "abc",
                                "Type": "abc"
                            },
                            "ColorEnhance": {
                                "Switch": "abc",
                                "Type": "abc"
                            },
                            "SharpEnhance": {
                                "Switch": "abc",
                                "Intensity": 0
                            },
                            "FaceEnhance": {
                                "Switch": "abc",
                                "Intensity": 0
                            },
                            "LowLightEnhance": {
                                "Switch": "abc",
                                "Type": "abc"
                            },
                            "ScratchRepair": {
                                "Switch": "abc",
                                "Intensity": 0
                            },
                            "ArtifactRepair": {
                                "Switch": "abc",
                                "Type": "abc"
                            }
                        },
                        "AudioEnhance": {
                            "Denoise": {
                                "Switch": "abc"
                            },
                            "Separate": {
                                "Switch": "abc",
                                "Type": "abc",
                                "Track": "abc"
                            },
                            "VolumeBalance": {
                                "Switch": "abc",
                                "Type": "abc"
                            },
                            "Beautify": {
                                "Switch": "abc",
                                "Types": [
                                    "abc"
                                ]
                            }
                        }
                    }
                }
            ],
            "RequestId": "abc"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.InvalidMpsUser 操作失败:非法 mps 用户。
    InternalError 内部错误。
    InternalError.AccessDBError 数据错误。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.ContainerType 参数值错误:ContainerType。
    InvalidParameterValue.Definitions 参数错误:Definitions。
    InvalidParameterValue.Limit 参数错误:Limit。
    InvalidParameterValue.TEHDType 参数值错误:TEHD Type 无效。
    InvalidParameterValue.Type 参数错误:Type 参数值错误。
    ResourceNotFound.TemplateNotExist 资源不存在:模板不存在。