tencent cloud

APIs

文档APIsVideo on DemandParameter Template APIsModifyAdaptiveDynamicStreamingTemplate

ModifyAdaptiveDynamicStreamingTemplate

下载
聚焦模式
字号
最后更新时间: 2026-09-18 16:50:06

1. API Description

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

Modifying 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 identifier of the adaptive transcoding template.

SubAppId No Integer

On-demand application ID. For customers who activate on-demand services after December 25, 2023, this field must be filled with the app ID when accessing resources in on-demand applications (whether the default application or a newly created application).

Name No String

Template name. Length limit: 64 characters.

Format No String

Adaptive Transcoding Format. Value range:

  • HLS;
  • MPEG-DASH.
  • DisableHigherVideoBitrate No Integer

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

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

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

  • 0: No,
  • 1: Yes.
  • StreamInfos.N No Array of AdaptiveStreamTemplate

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

    Comment No String

    Transcoding template description. Length limit: 256 characters.

    SegmentType No String

    Shard type. Available 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 shard format of adaptive bitrate is based on this field. For DASH, SegmentType can only be mp4-mp4-byterange.

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

    SegmentDuration No Integer

    Average segmentation duration.

    Value range: [1, 10]

    Unit: second

    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.intl.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

    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.
    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.Definition Parameter error: Definition.
    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.
    ResourceNotFound.TemplateNotExist Resource does not exist: template does not exist.

    帮助和支持

    本页内容是否解决了您的问题?

    填写满意度调查问卷,共创更好文档体验。

    文档反馈