tencent cloud

APIs

DescribeTranscodeTemplates

Download
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-05-19 15:00:48

1. API Description

Domain name for API request: vod.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: 2018-07-17.
Region No String Common Params. This parameter is not required.
SubAppId No Integer VOD application ID. Customers who activate VOD services after December 25, 2023 must fill this field with the application ID when accessing resources in on-demand applications (whether default or newly created).
Definitions.N No Array of Integer Filter condition for the unique identifier of the transcoding template. The array can contain up to 100 unique identifiers.
Type No String Condition for filtering templates by type. Valid values:
  • Preset: system preset template;
  • Custom: User-defined template.
  • ContainerType No String Muxing format filter condition. Available values:
  • Video: Video format that contains both video stream and audio stream in a muxing format.
  • PureAudio: Pure audio format, a muxing format that can only contain audio streams.
  • TEHDType No String Top Speed Codec filter conditions for filtering standard transcoding or TSC transcoding templates. Available values:
  • Common: standard transcoding template.
  • TEHD: Ultra-HD template.
  • Offset No Integer Pagination offset. Default value: 0.
    Limit No Integer Number of returned entries. Default value: 10. Maximum value: 100.
    EnhanceType No String Enhancement type. Valid values:
  • VideoEnhance: video enhancement only.
  • AudioEnhance (audio enhancement only).
  • AudioVideoEnhance: audio and video enhancement included.
  • AnyEnhance (including video enhancement only, audio enhancement only, audio and video enhancement)
  • None (non-enhanced)
  • EnhanceScenarioType No String Enhance scenario configuration. Available values:
  • common (general): general enhancement parameter, suitable for basic optimization parameters of various video types to improve overall video quality.
  • AIGC: overall resolution enhancement. It uses AI technology to improve the overall video resolution and image clarity.
  • short_play (mini-drama): enhances face and subtitle details, highlights facial expression details and subtitle clarity to improve viewing experience.
  • short_video (short video): optimizes complex and diverse image quality issues, targets complex scenarios in short videos, improves video quality, and addresses multiple visual problems.
  • game (gaming video): restores motion blur, enhances details, focuses on improving game detail clarity, restores motion blur areas, and makes the game screen content clearer and more vivid.
  • HD_movie_series (UHD TV shows and movies): achieves ultra-high-definition smooth effects, targets the demand for UHD videos in broadcasting and OTT scenarios, and generates UHD standard videos in 4K 60fps HDR. Supports broadcasting scenario format standards.
  • LQ_material (low-quality material/classic film restoration): improves overall resolution, specifically optimizes issues in old videos such as insufficient resolution, blur distortion, scratch damage, and color temperature due to their age.
  • lecture (showroom/e-commerce/conference/lecture): beautifies and enhances face effects, specifically optimizes face regions, noise reduction, and burr processing for scenarios where figures are explained in showrooms, e-commerce, conferences, or lectures.
  • 3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of records that meet the filtering conditions.
    TranscodeTemplateSet Array of TranscodeTemplate Transcoding template detail list.
    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 Obtaining Transcoding Templates

    Input Example

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

    Output Example

    {
        "Response": {
            "TotalCount": 1,
            "TranscodeTemplateSet": [
                {
                    "Definition": "1008",
                    "Container": "mp4",
                    "Name": "Template 1",
                    "Comment": "MyTranscodeTemplate",
                    "Type": "Custom",
                    "RemoveVideo": 0,
                    "RemoveAudio": 0,
                    "SegmentType": "",
                    "ContainerType": "Video",
                    "TEHDConfig": null,
                    "EnhanceConfig": null,
                    "VideoTemplate": {
                        "Codec": "libx264",
                        "Fps": 24,
                        "FillType": "black",
                        "Bitrate": 256,
                        "CodecTag": "hvc1",
                        "Gop": 0,
                        "Vcrf": 23,
                        "PreserveHDRSwitch": "OFF",
                        "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

    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.ScenarioType Invalid scenario type parameter value.
    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.

    도움말 및 지원

    문제 해결에 도움이 되었나요?

    피드백