tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateTranscodeTemplate

Last updated: 2024-09-30 14:48:58

    1. API Description

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

    This API is used to create a custom transcoding template. Up to 1,000 templates can be created.

    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: CreateTranscodeTemplate.
    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.
    Container Yes String Container format. Valid values: mp4, flv, hls, ts, webm, mkv, mxf, mov, mp3, flac, ogg, and m4a. Among them, mp3, flac, ogg, and m4a are for audio-only files.
    Name No String Name of a transcoding template. Length limit: 64 characters.
    Comment No String Template description. Length limit: 256 characters.
    RemoveVideo No Integer Whether to remove video data. Valid values:
  • 0: Retain
  • 1: Remove

    • Default value: 0.
    RemoveAudio No Integer Whether to remove audio data. Valid values:
  • 0: Retain
  • 1: Remove

    • Default value: 0.
    VideoTemplate No VideoTemplateInfo Video stream configuration parameter. This field is required when RemoveVideo is 0.
    AudioTemplate No AudioTemplateInfo Audio stream configuration parameter. This field is required when RemoveAudio is 0.
    TEHDConfig No TEHDConfig TESHD transcoding parameter. To enable it, please contact your Tencent Cloud sales rep.
    EnhanceConfig No EnhanceConfig Audio/Video enhancement configuration.

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer Unique ID of a transcoding template.
    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 Creating a Transcoding Template

    Input Example

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



{
    "RemoveVideo": 0,
    "Container": "mp4",
    "Name": "test",
    "AudioTemplate": {
        "SampleRate": 44100,
        "Codec": "aac",
        "Bitrate": 200
    },
    "VideoTemplate": {
        "Codec": "h264",
        "Bitrate": 256,
        "Fps": 45
    },
    "RemoveAudio": 0
}

    Output Example

    {
    "Response": {
        "Definition": 1008,
        "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.InvalidMpsUser Operation failed: unauthorized MPS user.
    InternalError Internal error.
    InternalError.AccessDBError Data error.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.AudioBitrate Parameter error: Audio stream bitrate.
    InvalidParameterValue.AudioChannel Incorrect parameter value: AudioChannel.
    InvalidParameterValue.AudioCodec Parameter error: audio stream codec.
    InvalidParameterValue.AudioSampleRate Parameter error: audio stream sample rate.
    InvalidParameterValue.Container Parameter error: container format.
    InvalidParameterValue.Fps Parameter error: video frame rate.
    InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.RemoveAudio Incorrect parameter value: RemoveAudio.
    InvalidParameterValue.RemoveVideo Incorrect parameter value: RemoveVideo.
    InvalidParameterValue.Resolution Parameter error: Incorrect resolution.
    InvalidParameterValue.SampleRate Invalid audio sample rate.
    InvalidParameterValue.TEHDType Incorrect parameter value: invalid TEHD Type .
    InvalidParameterValue.Type Parameter error: incorrect Type value.
    InvalidParameterValue.VideoBitrate Parameter error: video stream bitrate.
    InvalidParameterValue.VideoCodec Parameter error: video stream codec.
    LimitExceeded.TooMuchTemplate Limit reached: the number of templates exceeds the limit.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy