DescribeTranscodeTemplates

Last updated: 2023-10-12 16:44:41Download PDF

1. API Description

Domain name for API request: mps.tencentcloudapi.com.

This API is used to get the list of transcoding templates based on unique template ID. The return result includes all eligible custom and preset transcoding templates.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeTranscodeTemplates.
Version	Yes	String	Common Params. The value used for this API: 2019-06-12.
Region	No	String	Common Params. This parameter is not required for this API.
Definitions.N	No	Array of Integer	Unique ID filter of transcoding templates. Array length limit: 100.
Type	No	String	Template type filter. Valid values: Preset: Preset template; Custom: Custom template.
ContainerType	No	String	Container format filter. Valid values: Video: Video container format that can contain both video stream and audio stream; PureAudio: Audio container format that can contain only audio stream.
TEHDType	No	String	TESHD filter, which is used to filter common transcoding or ultra-fast HD transcoding templates. Valid values: Common: Common transcoding template; TEHD: TESHD template.
Offset	No	Integer	Paging offset. Default value: 0.
Limit	No	Integer	Number of returned entries. Default value: 10. Maximum value: 100.
TranscodeType	No	String	The template type (replacing `TEHDType`). Valid values: Common: Common transcoding template TEHD: TESHD template Enhance: Audio/Video enhancement template. This parameter is left empty by default, which indicates to return all types of templates.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of eligible entries.
TranscodeTemplateSet	Array of TranscodeTemplate	List of transcoding template details.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying transcoding templates

Input Example

POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTranscodeTemplates
<Common request parameters>

{
    "Definitions": [
        "10"
    ]
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "TranscodeTemplateSet": [
            {
                "Definition": 1008,
                "Container": "mp4",
                "Name": "Template 1",
                "Comment": null,
                "Type": "Preset",
                "RemoveVideo": 0,
                "RemoveAudio": 0,
                "VideoTemplate": {
                    "Codec": "libx264",
                    "Fps": 24,
                    "Bitrate": 256,
                    "ResolutionAdaptive": "open",
                    "Width": 0,
                    "Height": 0,
                    "FillType": "black"
                    "Vcrf": 23
                },
                "AudioTemplate": {
                    "Codec": "libfdk_aac",
                    "Bitrate": 48,
                    "SampleRate": 48000,
                    "AudioChannel": 2
                },
                "TEHDConfig": {
                    "MaxVideoBitrate": 1,
                    "Type": "TEHD-100"
                },
                "ContainerType": "Video",
                "CreateTime": "2018-10-01T10:00:00Z",
                "UpdateTime": "2018-10-01T10:00:00Z"
            }
        ],
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.InvalidMpsUser	Operation failed: unauthorized MPS user.
InternalError	Internal error.
InternalError.AccessDBError	Data error.
InvalidParameterValue	Incorrect parameter value.
InvalidParameterValue.ContainerType	Incorrect parameter value: ContainerType.
InvalidParameterValue.Definitions	Parameter error: Definitions.
InvalidParameterValue.Limit	Parameter error: Limit.
InvalidParameterValue.TEHDType	Incorrect parameter value: invalid `TEHD Type` .
InvalidParameterValue.Type	Parameter error: incorrect `Type` value.
ResourceNotFound.TemplateNotExist	The resource does not exist: the template does not exist.