1. API Description

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

Live stream clipping refers to generating a new video (HLS format) in real time from a selected segment of the live stream portion during live streaming (when the live stream has not yet ended). Developers can share it immediately or store it for long-term preservation.

Tencent Cloud VOD supports two real-time editing modes:

• Edit and solidify: Save the edited video as a standalone video with an independent FileId. This is suitable for long-term preservation of highlight clips.
• Editing is not solidified: the edited video is attached to the live streaming recording file and has no standalone FileId. It is suitable for scenarios where highlight clips are temporarily shared.

Note:

• The premise for using the live stream clipping feature is that the target live stream has the time shifting and playback (https://www.tencentcloud.com/document/product/267/32742?from_cn_redirect=1) feature enabled.
  -Live streaming Instant Editing is based on the m3u8 file generated by live recording, so its minimum editing precision is one ts slicing. Second-level or more precise editing precision cannot be achieved.
  -Since stream disconnection may occur during live streaming, the actual video duration generated by editing may differ from the expected duration. For example, if you edit a live stream from 2018-09-20T10:30:00Z to 2018-09-20T10:40:00Z, and stream disconnection occurred during this time interval, the returned media file duration will be less than 10 minutes. In such cases, you can perceive it through the output parameter SegmentSet.

Edit solidification

Clipping persistence refers to saving the edited video as an independent video with its own FileId. Its lifecycle is not subject to any impact from the original live recorded video. Even if the original recorded video is deleted, the clipping result is not affected. You can also transcode it or publish it on WeChat for post-processing.

For example, a complete football match may have a live recording lasting over 2 hours. For cost savings, the customer can store the original video for 2 months, but can specify longer storage for the highlight reel from live stream clipping. You can also perform additional on-demand operations on the highlight reel separately, such as transcoding and publishing on WeChat. In this case, you can choose the live stream clipping and persistence solution.

The advantage of solidifying editing is that its lifecycle is independent of the original recorded video, and it can be managed separately and preserved long-term.

Note: If solidification is specified when editing, enable reception of editing solidification event notifications through the ModifyEventConfig API. After successful solidification, you will receive a PersistenceComplete event notification. Before receiving this event notification, you should not delete or archive the live video recording. Otherwise, playback of the generated video may be abnormal.

Editing is not solidified

Non-solidified editing means that the result of editing (m3u8 file) shares the same TS segments with the live video recording. The generated video is not an independent and complete video (no independent FileId, only a playback URL), and its valid period is consistent with that of the full video of the live recording. Once the live recorded video is deleted, this clip will also become unplayable.

Editing is not solidified. Since the clipping result is not an independent video, it is not included in the video management of on-demand media assets. For example, the total number of videos in the console does not count this clip. It is also unable to separately target this clip for any video processing operation such as transcoding or publishing on WeChat.

The advantage of not solidifying editing is that the editing operation is relatively "lightweight" and will not generate additional storage overhead. However, its shortcoming is that the lifecycle is the same as the original recorded video, and it is unable to further transcode or perform other video processing.

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 Instant editing is not solidified

Trigger instant clipping for a live stream with the live stream code record-stream and domain name example.com. The start time is 2018-09-20T10:00:00Z, the end time is 2018-09-20T11:00:00Z, and no solidification is applied. Suppose the live stream was interrupted from 2018-09-20T10:30:00Z to 2018-09-20T10:40:00Z, with a duration of 10 minutes. Then the output parameter SegmentSet will contain two segment information entries, and the actual duration of the video after trimming is 50 minutes.

Input Example

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

{
    "Host": "example.com",
    "EndTime": "2018-09-20T11:00:00Z",
    "StartTime": "2018-09-20T10:00:00Z",
    "StreamId": "record-stream"
}

Output Example

{
    "Response": {
        "Url": "http://example.com/playlist.m3u8",
        "FileId": "",
        "VodTaskId": "",
        "MetaData": null,
        "SegmentSet": [
            {
                "StartTime": "2018-09-20T10:00:00Z",
                "EndTime": "2018-09-20T10:30:00Z"
            },
            {
                "StartTime": "2018-09-20T10:40:00Z",
                "EndTime": "2018-09-20T11:00:00Z"
            }
        ],
        "RequestId": "6ca31e3a-6b8e-xxxx-9256-fdc700064ef3"
    }
}

Example2 Real-time clipping and solidification

This example shows you how to trigger instant clipping for a live stream with the live stream code record-stream and domain name example.com, with a start time of 2018-09-20T12:00:00Z and an end time of 2018-09-20T13:00:00Z, and then process it for persistence and task flow initiation.

Input Example

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

{
    "IsPersistence": 1,
    "Host": "example.com",
    "StartTime": "2018-09-20T12:00:00Z",
    "StreamId": "record-stream",
    "EndTime": "2018-09-20T13:00:00Z",
    "Procedure": "SomeProcedure"
}

Output Example

{
    "Response": {
        "Url": "http://example.com/playlist.m3u8",
        "FileId": "5285890xxxxxx199336",
        "VodTaskId": "125xxxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca",
        "MetaData": null,
        "SegmentSet": [
            {
                "StartTime": "2018-09-20T12:00:00Z",
                "EndTime": "2018-09-20T13:00:00Z"
            }
        ],
        "RequestId": "6ca31e3a-6b8e-xxxx-9256-fdc700064ef3"
    }
}

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.