tencent cloud



Last updated: 2022-10-28 15:17:42

1. API Description

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

This API is used to create an adaptive bitrate streaming template. Up to 100 templates can be created.

A maximum of 20 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: CreateAdaptiveDynamicStreamingTemplate.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required for this API.
Format Yes String The adaptive bitrate streaming format. Valid values:
  • HLS
  • StreamInfos.N Yes Array of AdaptiveStreamTemplate Parameter information of output substream for adaptive bitrate streaming. Up to 10 substreams can be output.
    Note: the frame rate of all substreams must be the same; otherwise, the frame rate of the first substream will be used as the output frame rate.
    SubAppId No Integer The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.
    Name No String Template name. Length limit: 64 characters.
    DrmType No String The DRM type. Valid values:
  • SimpleAES
  • Widevine
  • FairPlay

  • If this parameter is an empty string, it indicates that the video is not protected by DRM.
    DrmKeyProvider No String The provider of the DRM key. Valid values:
  • SDMC
  • VOD

  • The default is VOD.
    DisableHigherVideoBitrate No Integer Whether to prohibit transcoding video from low bitrate to high bitrate. Valid values:
  • 0: no,
  • 1: yes.

  • Default value: no.
    DisableHigherVideoResolution No Integer Whether to prohibit transcoding from low resolution to high resolution. Valid values:
  • 0: no,
  • 1: yes.

  • Default value: no.
    Comment No String Template description. Length limit: 256 characters.
    SegmentType No String The segment type. This parameter is valid only if Format is HLS. Valid values:
  • ts: TS segment
  • fmp4: fMP4 segment

  • Default: ts

    3. Output Parameters

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

    4. Example

    Example1 Creating an adaptive bitrate streaming template

    Input Example

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateAdaptiveDynamicStreamingTemplate
    <Common request parameters>
        "StreamInfos": [
                "Audio": {
                    "SampleRate": "44100",
                    "Codec": "flac",
                    "Bitrate": "1024"
                "Video": {
                    "Codec": "libx264",
                    "Bitrate": "2000",
                    "Fps": "25"
        "Name": "Adaptive bitrate streaming template 1",
        "Format": "HLS"

    Output Example

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

    5. Developer Resources


    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.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.Bitrate Invalid audio/video bitrate.
    InvalidParameterValue.Codec Invalid audio/video codec.
    InvalidParameterValue.Comment Invalid parameter: template description.
    InvalidParameterValue.DisableHigherVideoBitrate Invalid value of the switch for prohibiting transcoding from low bitrate to high bitrate.
    InvalidParameterValue.DisableHigherVideoResolution Invalid value of the switch for prohibiting transcoding from low resolution to high resolution.
    InvalidParameterValue.DrmType Invalid DRM type.
    InvalidParameterValue.FillType Invalid parameter: incorrect fill type.
    InvalidParameterValue.Format Incorrect parameter value: Format.
    InvalidParameterValue.Fps Invalid parameter: video frame rate.
    InvalidParameterValue.Height Invalid parameter: height.
    InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.RemoveAudio Incorrect parameter value: RemoveAudio.
    InvalidParameterValue.SampleRate Invalid audio sample rate.
    InvalidParameterValue.SoundSystem Incorrect parameter: audio channel system.
    InvalidParameterValue.Width Invalid parameter: width.
    LimitExceeded.TooMuchTemplate Limit exceeded: the number of templates exceeds the limit.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support