tencent cloud



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

    1. API Description

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

    This API is used to modify an adaptive bitrate streaming template.

    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: ModifyAdaptiveDynamicStreamingTemplate.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    Definition Yes Integer Unique ID of adaptive bitrate streaming template.
    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.
    Format No String The adaptive bitrate streaming format. Valid values:
  • HLS
  • DisableHigherVideoBitrate No Integer Whether to prohibit transcoding video from low bitrate to high bitrate. Valid values:
  • 0: no,
  • 1: yes.
  • DisableHigherVideoResolution No Integer Whether to prohibit transcoding from low resolution to high resolution. Valid values:
  • 0: no,
  • 1: yes.
  • StreamInfos.N No Array of AdaptiveStreamTemplate Parameter information of input stream for adaptive bitrate streaming. Up to 10 streams can be input.
    Note: the frame rate of all streams must be the same; otherwise, the frame rate of the first stream will be used as the output frame rate.
    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
  • 3. Output Parameters

    Parameter Name Type Description
    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 Modifying an adaptive bitrate streaming template

    Input Example

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

    Output Example

        "Response": {
            "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.
    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.Definition Invalid parameter: Definition.
    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.
    ResourceNotFound.TemplateNotExist The resource does not exist: the template does not exist.
    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