tencent cloud

APIs

DocumentaçãoAPIsVideo on DemandParameter Template APIsDescribeTranscodeTemplates

DescribeTranscodeTemplates

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-22 22:25:02

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This API is used to retrieve the transcoding template detail list based on the transcoding template unique identifier. The returned results include all eligible custom templates and system 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. For customers who activate VOD after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application).
Definitions.N No Array of Integer Filtering condition for the unique identifier of the transcoding template. The array length cannot exceed 100.
Type No String Condition for filtering templates by type. Valid values:
  • Preset: system-preset template;
  • Custom: custom template.
    		•
    ContainerType No String Muxing format filter criteria. Available values:
  • Video: Video format. A container format that can contain both video and audio streams.
  • PureAudio: Pure audio format, a container format that can only contain audio streams.
    		•
    TEHDType No String TSC filter criteria for filtering standard 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.
  • AnyEnhance (including video enhancement only, audio enhancement only, and audio and video enhancement)
  • None (non-enhanced)
    		•
    EnhanceScenarioType No String Enhancement scenario configuration. Available values:
  • common: general enhancement parameters, basic optimization parameters suitable for various video types to improve overall video quality.
  • AIGC: overall resolution enhancement, using AI technology to improve the overall video resolution and enhance image clarity.
  • short_play: enhance face and subtitle details, highlight facial expression details and subtitle clarity to improve the viewing experience.
  • short_video: optimize complex and diverse image quality issues, optimize video quality for complex short video scenarios and address multiple visual issues.
  • game: repair motion blur and enhance details, focusing on improving the clarity of game details, restoring motion blur areas, and making game screen content clearer and richer.
  • HD_movie_series: obtain ultra-high-definition smooth effects, generate 4K 60fps HDR ultra-high-definition standard videos for UHD video demands in broadcasting and OTT. Support broadcasting scenario format standards.
  • LQ_material: overall resolution enhancement, specially optimized for issues in old videos such as insufficient resolution, blur distortion, scratch damage, and color temperature caused by older shooting conditions.
  • lecture: beautify and enhance face effects, specially optimized for face region, noise reduction, and burr processing in scenarios where people explain content, such as live shows, e-commerce, conferences, and 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 enabled.
    InternalError Internal error.
    InvalidParameterValue.ContainerType Parameter value error: ContainerType.
    InvalidParameterValue.Definitions Parameter error: Definitions.
    InvalidParameterValue.Limit Parameter error: Limit.
    InvalidParameterValue.ScenarioType The scenario type parameter value is invalid.
    InvalidParameterValue.TEHDType Parameter value error: TEHD Type is invalid.
    InvalidParameterValue.Type Type parameter value error.
    ResourceNotFound.TemplateNotExist Resource does not exist: template does not exist.
    UnauthorizedOperation Unauthorized operation.
    Anterior: ModifyAIAnalysisTemplatePróximo: DescribeWatermarkTemplates

    Ajuda e Suporte

    Esta página foi útil?

    comentários

    Search
      Enter keywords to search documentation