DescribeTranscodeTemplates
Last updated: 2025-02-19 14:55:11Download PDF
1. API Description
Domain name for API request: mps.intl.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: |
| ContainerType | No | String | Container format filter. Valid values: |
| TEHDType | No | String | TESHD filter, which is used to filter common transcoding or ultra-fast HD transcoding templates. Valid values: |
| 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:This parameter is left empty by default, which indicates to return all types of templates. |
| Name | No | String | Filter condition for transcoding template identifiers, with a length limit of 64 characters. |
| SceneType | No | String | Video scenario. Optional values: normal: General transcoding scenario: General transcoding and compression scenario. pgc: PGC HD TV shows and movies: At the time of compression, focus is placed on the viewing experience of TV shows and movies and ROI encoding is performed according to their characteristics, while high-quality contents of videos and audio are retained. materials_video: HD materials: Scenario involving material resources, where requirements for image quality are extremely high and there are many transparent images, with almost no visual loss during compression. ugc: UGC content: It is suitable for a wide range of UGC/short video scenarios, with an optimized encoding bitrate for short video characteristics, improved image quality, and enhanced business QOS/QOE metrics. e-commerce_video: Fashion show/e-commerce: At the time of compression, emphasis is placed on detail clarity and ROI enhancement, with a particular focus on maintaining the image quality of the face region. educational_video: Education: At the time of compression, emphasis is placed on the clarity and readability of text and images to help students better understand the content, ensuring that the teaching content is clearly conveyed. no_config: Not configured. |
| CompressType | No | String | Transcoding policy. Optional values: ultra_compress: Extreme compression: Compared to standard compression, this policy can maximize bitrate compression while ensuring a certain level of image quality, thus greatly saving bandwidth and storage costs. standard_compress: Comprehensively optimal: The compression ratio and image quality are balanced, and files are compressed as much as possible without a noticeable reduction in subjective image quality. Only audio and video TSC transcoding fees are charged for this policy. high_compress: Bitrate priority: Priority is given to reducing file size, which may result in certain image quality loss. Only audio and video TSC transcoding fees are charged for this policy. low_compress: Image quality priority: Priority is given to ensuring image quality, and the size of compressed files may be relatively large. Only audio and video TSC transcoding fees are charged for this policy. no_config: Not configured. |
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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 This example shows you how to obtain transcoding templates.
This example shows you how to obtain transcoding templates.
Input Example
POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTranscodeTemplates
<Common request parameters>
{
"Definitions": [
"10"
]
}
Output Example
{
"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. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
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. |