CreateTranscodeTemplate

Last updated: 2020-01-13 11:51:18

    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.

    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 parameter. The value used for this API: CreateTranscodeTemplate
    Version Yes String Common parameter. The value used for this API: 2019-06-12
    Region No String Common parameter. This parameter is not required for this API.
    Container Yes String Container format. Valid values: mp4; flv; hls; mp3; flac; ogg; m4a. Among them, mp3, flac, ogg, and m4a are for audio 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.

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer Unique ID of a transcoding template.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1

    Input Example

    https://mps.tencentcloudapi.com/?Action=CreateTranscodeTemplate
    &Container=mp4
    &Name=TranscodeTemplate1
    &RemoveVideo=0
    &RemoveAudio=0
    &VideoTemplate.Codec=libx264
    &VideoTemplate.Fps=45
    &VideoTemplate.Bitrate=256
    &AudioTemplate.Codec=libfdk_aac
    &AudioTemplate.Bitrate=200
    &AudioTemplate.SampleRate=200
    &<common request parameters>

    Output Example

    {
      "Response": {
        "Definition": 1008,
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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.
    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.RemoveAudio Incorrect parameter value: RemoveAudio.
    InvalidParameterValue.RemoveVideo Incorrect parameter value: RemoveVideo.
    InvalidParameterValue.Resolution Parameter error: Incorrect resolution.
    InvalidParameterValue.TEHDType Incorrect parameter value: invalid TEHD Type .
    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.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help