tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateAdaptiveDynamicStreamingTemplate

Last updated: 2024-03-27 16:09:25

    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.
    Format Yes String The adaptive bitrate streaming format. Valid values:
  • HLS
  • MPEG-DASH
    		•
    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 application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    Name No String Template name. Length limit: 64 characters.
    DrmType No String DRM scheme type, value range:
  • SimpleAES
  • Widevine
  • FairPlay

    • The default value is an empty string. It is an empty string, indicating that the video will not be DRM protected.
    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, 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 CreateAdaptiveDynamicStreamingTemplate

    Create Adaptive Dynamic Streaming Template.

    Input Example

    POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAdaptiveDynamicStreamingTemplate
<Public Request Parameter>

{
    "StreamInfos": [
        {
            "Audio": {
                "SampleRate": "44100",
                "Codec": "flac",
                "Bitrate": "1024"
            },
            "Video": {
                "Codec": "libx264",
                "Bitrate": "2000",
                "Fps": "25"
            }
        }
    ],
    "Name": "Adaptive Bitrate Streaming Template1",
    "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 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 upper limit of 100. If you need more, pleaseSubmit a ticket。
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy