tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateComplexAdaptiveDynamicStreamingTask

Last updated: 2024-11-06 16:01:32

1. API Description

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

Initiate an adaptive bitrate streaming processing task, with the following features:

  1. Output HLS and MPEG-DASH adaptive streams based on the specified templates;
  2. DRM options for the adaptive bitrate streaming include no encryption, Widevine, or FairPlay.
  3. The output adaptive bitrate streaming can include multiple audio streams in different languages, with each language sourced from different media files.
  4. The output adaptive stream can also include multiple subtitle streams in different languages.

Notes:

  1. When using opening/closing credits, the video stream in the opening credit must be synchronized with the audio stream; otherwise, it will result in audio and video desynchronization in the output content.
  2. If the output adaptive bitrate streaming needs to include audio from the main media, the FileId of the main media must be specified in the AudioSet parameter.
  3. Subtitles must be added to the main media beforehand, which can be done through the ModifyMediaInfo API interface or the Video Management page in the console.
  4. Support for TESHD transcoding and watermarking is currently not available.

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: CreateComplexAdaptiveDynamicStreamingTask.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
SubAppId Yes Integer The VOD application ID.
FileId Yes String Media ID of the main media.
StreamParaSet.N Yes Array of ComplexAdaptiveDynamicStreamingTaskStreamPara Adaptive bitrate streaming parameters, supporting up to 8 entries.
HeadTailSet.N No Array of HeadTailTaskInput List of video opening/closing credits configuration template IDs, supporting up to 4 entries. If this field is filled in, the start times of the media specified in AudioSet and SubtitleSet will be automatically adjusted to stay in sync with the main media.
AudioSet.N No Array of ComplexAdaptiveDynamicStreamingTaskAudioInput Audio media parameters, supporting up to 16 entries. Each array element corresponds to an audio stream in the output. If you want to add the audio stream from the main media file to the output, you also need to specify it here. The order of elements in the array will determine the order of audio streams in the output. If the input media file contains both video and audio streams, the video stream will be ignored.
SubtitleSet.N No Array of ComplexAdaptiveDynamicStreamingTaskSubtitleInput List of subtitle IDs, supporting up to 16 entries. Each array element corresponds to an subtitle stream in the output. The order of elements in the array will determine the order of subtitles in the output.

3. Output Parameters

Parameter Name Type Description
TaskId String Task ID.
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 Initiate an adaptive bitrate streaming processing task

Transcode a media file (with video and Chinese audio) and package it into adaptive bitrate streaming, while additionally adding a opening credit, English audio, Chinese subtitles, and English subtitles. The FileId of the main media is 4424135347909043783, and both Chinese and English subtitles have been set; the FileId of the English audio that matches the main media is 4424135347909043652; the adaptive streaming template is 220368; and the head tail template for the opening credit is 14591.

Input Example

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

{
    "SubAppId": 1250000000,
    "FileId": "4424135347909043783",
    "StreamParaSet": [
        {
            "Definition": 220368
        }
    ],
    "HeadTailSet": [
        {
            "Definition": 14591
        }
    ],
    "AudioSet": [
        {
            "FileId": "4424135347909043783",
            "Name": "Chinese",
            "Language": "zh",
            "Default": "YES"
        },
        {
            "FileId": "4424135347909043652",
            "Name": "English",
            "Language": "en"
        }
    ],
    "SubtitleSet": [
        {
            "Id": "Chinese",
            "Default": "YES"
        },
        {
            "Id": "English"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "2e1af3fa-a55f-4078-9d61-df448c1e6e34",
        "TaskId": "1250000000-ComplexAdaptiveDynamicStreaming-a9e3993dd4fdee822862cd80c43ac4c4t"
    }
}

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.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Incorrect parameter value.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy