DescribeTranscodeTemplates

Last updated: 2024-03-27 16:08:15

1. API Description

Domain name for API request: vod.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: 2018-07-17.
Region	No	String	Common Params. This parameter is not required.
SubAppId	No	Integer	The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
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 filter. Valid values: Video: video container that can contain both video stream and audio stream; PureAudio: audio container 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	Pagination offset. Default value: 0.
Limit	No	Integer	Number of returned entries. Default value: 10. Maximum value: 100.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of eligible entries.
TranscodeTemplateSet	Array of TranscodeTemplate	List of transcoding template details. Note: this field may return null, indicating that no valid values can be obtained.
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 Querying transcoding templates

Input Example

https://vod.tencentcloudapi.com/?Action=DescribeTranscodeTemplates
&Definitions.0=10
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "TranscodeTemplateSet": [
            {
                "Definition": 1008,
                "Container": "mp4",
                "Name": "Template 1",
                "Comment": null,
                "Type": 0,
                "RemoveVideo": 0,
                "RemoveAudio": 0,
                "VideoTemplate": {
                    "Codec": "libx264",
                    "Fps": 24,
                    "Bitrate": 256,
                    "ResolutionAdaptive": "open",
                    "Width": 0,
                    "Height": 0
                },
                "AudioTemplate": {
                    "Codec": "libfdk_aac",
                    "Bitrate": 48,
                    "SampleRate": 48000,
                    "AudioChannel": 2
                },
                "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	Operation failed.
FailedOperation.InvalidVodUser	The VOD service is not activated.
InternalError	Internal error.
InvalidParameterValue.ContainerType	Incorrect parameter value: ContainerType.
InvalidParameterValue.Definitions	Invalid parameter: Definitions.
InvalidParameterValue.Limit	Invalid parameter: Limit.
InvalidParameterValue.TEHDType	Incorrect parameter value: `TEHD Type` is invalid.
InvalidParameterValue.Type	Incorrect `Type` parameter value.
ResourceNotFound.TemplateNotExist	The resource does not exist: the template does not exist.
UnauthorizedOperation	Unauthorized operation.

tencent cloud

Recent Pages