Domain name for API request: vod.intl.tencentcloudapi.com.
Create an adaptive bitrate streaming template. Max: 100.
A maximum of 20 requests can be initiated per second for this API.
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: |
| StreamInfos.N | Yes | Array of AdaptiveStreamTemplate | Adaptive Transcoding Output Substream Parameter Information. Up to 10 substreams can be output. |
| 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 in as the app ID. |
| Name | No | String | Template name. Length limit: 64 characters. |
| DrmType | No | String | DRM solution type. Value range: |
| DrmKeyProvider | No | String | Key provider for DRM. Value range: The SDMC service will gradually phase out subsequently. Please use the VOD DRM encryption service. |
| DrmEncryptType | No | String | Encryption method. Available values: If left blank |
| DisableHigherVideoBitrate | No | Integer | Whether to prohibit video low bitrate to high bitrate conversion. Value range: |
| DisableHigherVideoResolution | No | Integer | Whether to prohibit video resolution to high resolution conversion. Value range: |
| Comment | No | String | Transcoding template description. Length limit: 256 characters. |
| SegmentType | No | String | Segment type. Valid values: 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 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. |
| SegmentDuration | No | Integer | Segment duration. Value range: [1, 10] Unit: seconds Default value: 6 |
| 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. |
Creating an Adaptive Bitrate Streaming Template.
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"
}{
"Response": {
"Definition": 30018,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | VOD service is not enabled. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.Bitrate | Invalid audio/video bitrate. |
| InvalidParameterValue.Codec | Invalid audio/video encoding format. |
| InvalidParameterValue.Comment | Parameter error: description of this template. |
| InvalidParameterValue.DisableHigherVideoBitrate | Invalid forbidden bitrate low-to-high switch value. |
| InvalidParameterValue.DisableHigherVideoResolution | Invalid switch value for forbidding resolution upscaling. |
| 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 | Parameter value error: RemoveAudio. |
| InvalidParameterValue.SampleRate | Invalid audio sample rate. |
| InvalidParameterValue.SoundSystem | Parameter error: audio channel mode. |
| InvalidParameterValue.Width | Parameter error: width. |
| LimitExceeded.TooMuchTemplate | Exceed the limit: The number of templates exceeds the upper limit of 100. For more, please submit a ticket (https://console.tencentcloud.com/workorder/category). |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback