tencent cloud

1. API Description

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

This API is used to cut a clip from an HLS video to generate a new video (in HLS format). You can either share the new video or save it.

VOD supports two types of clipping:

• Clipping for persistent storage: The video clip is saved as an independent video file with its own FileId.
• Clipping for temporary sharing: The video clip shares FileId with the input file.

Notes:

• Clipping is based on the M3U8 file that contains a list of TS segments, so the smallest clipping unit is one TS segment instead of a second or less.

Clipping for persistent storage

In this mode, a video clip is saved as an independent video file with a FileId, and its lifecycle is not subject to the input video. Even if the source video is deleted, the video clip still exists. Moreover, the video clip can be transcoded, published on WeChat, and processed in other ways.

Suppose you recorded a two-hour football match. You want to save the full video for only two months to save costs, but want to save the highlights for a longer time and perhaps transcode and publish the highlight clip to WeChat. In this case, you can choose clipping for persistent storage.

The advantage of clipping for persistent storage is that the video clip has a lifecycle independent of the input video and can be managed independently and stored persistently.

Notice: If solidification is specified during clipping, enable the reception of persistence completed event notifications through the ModifyEventConfig interface. After successful solidification, an event notification of type PersistenceComplete will be received. Before receiving this event notification, operations such as deletion or cooling down of live recording videos should not be performed, otherwise, abnormal playback may occur in the video generated by the clipping.

Clipping for temporary sharing

The video clip (an M3U8 file) shares the same TS segments with the input video instead of being an independent video. It only has a playback URL but has no FileId, and its validity period is the same as that of the input video. Once the input video is deleted, the video clip cannot be played back.

Because the video clip is not an independent video, it's not displayed as a media asset in the VOD console, and cannot be transcoded or published to WeChat.

Clipping for temporary sharing is lightweight and incurs no additional storage fees. However, the video clip has the same lifecycle as the source recording video and cannot be transcoded or processed in other ways.

A maximum of 100 requests can be initiated per second for this API.

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.

3. Output Parameters

4. Example

Example1 Clipping an HLS video (with negative offsets)

This example shows you how to clip a video that starts at two seconds from the beginning of the original video and ends ten seconds from the end of the original video.

Input Example

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SimpleHlsClip
<Common request parameters>

{
    "Url": "http://xxxxx.vod2.myqcloud.com/xxxxx/aaaaaa/hhhh.m3u8",
    "StartTimeOffset": 2.0,
    "EndTimeOffset": 10.0
}

Output Example

{
    "Response": {
        "Url": "http://xxxxx.vod2.myqcloud.com/xxxxx/aaaaaa/10_50.m3u8",
        "FileId": "",
        "TaskId": "",
        "MetaData": {
            "Size": 0,
            "Container": "hls",
            "Bitrate": 622014,
            "Height": 480,
            "Width": 640,
            "Duration": 48.0,
            "Rotate": 0,
            "VideoStreamSet": [
                {
                    "Bitrate": 592385,
                    "Height": 480,
                    "Width": 640,
                    "Codec": "h264",
                    "Fps": 25,
                    "CodecTag": "",
                    "DynamicRangeInfo": {
                        "Type": "",
                        "HDRType": ""
                    }
                }
            ],
            "AudioStreamSet": [
                {
                    "Bitrate": 29629,
                    "SamplingRate": 44100,
                    "Codec": "aac"
                }
            ],
            "VideoDuration": 0.0,
            "AudioDuration": 0.0,
            "Md5": "Md5"
        },
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

Example2 Clipping an HLS video (with positive offsets)

This example shows you how to clip a video from 00:02 to 00:10.

Input Example

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SimpleHlsClip
<Common request parameters>

{
    "Url": "http://xxxxx.vod2.myqcloud.com/xxxxx/aaaaaa/hhh.m3u8",
    "StartTimeOffset": 2.0,
    "EndTimeOffset": 10.0
}

Output Example

{
    "Response": {
        "Url": "http://xxxxx.vod2.myqcloud.com/xxxxx/aaaaaa/10_50.m3u8",
        "FileId": "",
        "TaskId": "",
        "MetaData": {
            "Size": 0,
            "Container": "hls",
            "Bitrate": 622014,
            "Height": 480,
            "Width": 640,
            "Duration": 48.0,
            "Rotate": 0,
            "VideoStreamSet": [
                {
                    "Bitrate": 592385,
                    "Height": 480,
                    "Width": 640,
                    "Codec": "h264",
                    "Fps": 25,
                    "CodecTag": "",
                    "DynamicRangeInfo": {
                        "Type": "",
                        "HDRType": ""
                    }
                }
            ],
            "AudioStreamSet": [
                {
                    "Bitrate": 29629,
                    "SamplingRate": 44100,
                    "Codec": "aac"
                }
            ],
            "VideoDuration": 0.0,
            "AudioDuration": 0.0,
            "Md5": "Md5"
        },
        "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.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.