tencent cloud

APIs

문서APIsVideo on DemandParameter Template APIsCreateAdaptiveDynamicStreamingTemplate

CreateAdaptiveDynamicStreamingTemplate

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-09-18 18:10:30

1. API Description

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

Create adaptive bitrate streaming templates. Maximum quantity: 100.

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.
Format Yes String

Adaptive Transcoding Format. Value range:

  • HLS;
  • MPEG-DASH.
  • StreamInfos.N Yes Array of AdaptiveStreamTemplate

    Adaptive transcoding output substream parameter information. Up to 10 substreams can be output.
    Note: The frame rate of each substream must remain consistent. If inconsistent, the frame rate of the first substream is used as the output frame rate.

    SubAppId No Integer

    Video-on-demand (VOD) application ID. For customers who activate on-demand services from December 25, 2023, if they access resources in on-demand applications (whether the default application or a newly created application), this field must be filled with the application ID.

    Name No String

    Template name. Length limit: 64 characters.

    DrmType No String

    DRM solution type. Value range:

  • SimpleAES
  • Widevine
  • FairPlay
  • Widevine+FairPlay
  • The default value is an empty string. If the value is an empty string, it means no DRM protection is applied to the video.
    DrmKeyProvider No String

    Key provider for DRM. Valid values:

  • SDMC: SDMC;
  • VOD: VOD.
  • Default value: VOD.

    The SDMC service will be gradually phased out. Please use VOD DRM encryption service.

    DrmEncryptType No String

    Encryption method. Available values:
    cbcs: supported by Widevine, FairPlay, and WideVine+FairPlay;
    cenc: supported by Widevine;

    If left blank
    FairPlay: cbcs by default;
    Widevine: cenc by default;
    WideVine+FairPlay: cbcs by default;

    DisableHigherVideoBitrate No Integer

    Whether to prohibit video low bitrate to high bitrate conversion. Value range:

  • 0: No,
  • 1: Yes.
  • Default: No.
    DisableHigherVideoResolution No Integer

    Whether to prohibit video resolution to high resolution conversion. Value range:

  • 0: No,
  • 1: Yes.
  • No by default.
    Comment No String

    Transcoding template description. Length limit: 256 characters.

    SegmentType No String

    Segment type. Valid values:
    ts: HLS, internally mapped to ts-segment

    mp4: HLS/DASH, internally mapped to mp4-mp4-segment for HLS and mp4-mp4-byterange for DASH

    ts-segment: HLS+TS segment

    ts-byterange: HLS+TS byte range

    mp4-segment: HLS+MP4 segment

    mp4-byterange: HLS+MP4 byte range

    ts-packed-audio: HLS+TS+Packed Audio segment

    mp4-packed-audio: HLS+MP4+Packed Audio segment

    ts-ts-segment: HLS+TS+TS segment

    ts-ts-byterange: HLS+TS+TS byte range

    mp4-mp4-segment: HLS+MP4+MP4 segment

    mp4-mp4-byterange: HLS/DASH+MP4+MP4 byte range

    ts-packed-audio-byterange: HLS+TS+Packed Audio byte range

    mp4-packed-audio-byterange: HLS+MP4+Packed Audio byte range
    Default value: ts-segment. Note: The segment format for adaptive bitrate streams is based on this field. For DASH, SegmentType can only be mp4-mp4-byterange.

    FairPlay: can only be used for HLS, and the segment format can only be mp4 or mp4-mp4-segment. Widevine: can be used for HLS and DASH. For HLS, the segment format can only be mp4 or mp4-mp4-segment. For DASH, the segment format can only be mp4 or mp4-mp4-byterange.
    Widevine+FairPlay: can only be used for HLS, and the segment format can only be mp4 or mp4-mp4-segment

    SegmentDuration No Integer

    Segment duration.

    Value range: [1, 10]

    Unit: seconds

    Default value: 6

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer

    Adaptive Transcoding Template Unique Identifier.

    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 an Adaptive Bitrate Streaming Template

    Creating an adaptive bitrate streaming template.

    Input Example

    POST / HTTP/1.1
    Host: vod.intl.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

    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.
    InvalidParameter Parameter error.
    InvalidParameterValue Parameter value error.
    InvalidParameterValue.Bitrate Invalid audio/video bitrate.
    InvalidParameterValue.Codec Invalid audio/video coding format.
    InvalidParameterValue.Comment Parameter error: description of this template.
    InvalidParameterValue.DisableHigherVideoBitrate Invalid forbidden low-to-high bitrate switch value.
    InvalidParameterValue.DisableHigherVideoResolution Invalid forbidden low-to-high resolution switch value.
    InvalidParameterValue.DrmType Invalid DRM type.
    InvalidParameterValue.FillType Parameter error: incorrect filling method.
    InvalidParameterValue.Format Parameter value error: Format.
    InvalidParameterValue.Fps Parameter error: video frame rate.
    InvalidParameterValue.Height Parameter error: height.
    InvalidParameterValue.Name Parameter value error: Name exceeds the length limit.
    InvalidParameterValue.RemoveAudio Invalid parameter value: RemoveAudio.
    InvalidParameterValue.SampleRate Invalid audio sample rate.
    InvalidParameterValue.SoundSystem Incorrect parameter: audio channel mode.
    InvalidParameterValue.Width Parameter error: width.
    LimitExceeded.TooMuchTemplate Exceed the limit: The number of templates exceeds the upper limit of 100. If needed, submit a ticket (https://console.tencentcloud.com/workorder/category).

    도움말 및 지원

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

    피드백