tencent cloud

Feedback

FastEditMedia

Last updated: 2024-09-24 17:24:25

1. API Description

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

Implement quick concatenation and quick clipping for Tencent Cloud VOD's HLS videos to generate new media in HLS format. The video generated by quick concatenation or clipping will produce a new FileId and undergo solidification. After successful solidification, the new video file exists independently of the original input video and is not affected by deletions or other actions on the original video. Note: Enable the reception of persistence completed event notifications through the ModifyEvent config interface, and a PersistenceComplete type event notification will be received after successful solidification. Before receiving this event notification, operations such as deletion or cooling down of the original input video should not be performed, otherwise, abnormal playback may occur in the video generated by the concatenation and clipping.

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: FastEditMedia.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
FileInfos.N Yes Array of FastEditMediaFileInfo Input media file information. Support for up to 100 media inputs.
ClipMode No String ClipMode is used to indicate whether to include this segment when the clipping time point falls in the middle of a TS segment. There are two values:
  • StartInclusiveEndInclusive: When the clip start time point and end time point fall in the middle of a segment, this segment will be included;
  • StartInclusiveEndExclusive: When the starting time point falls in the middle of a segment, the segment will be included; when the end time point falls in the middle of a segment, the segment will not be included.
  • If not specified, the default is StartInclusiveEndInclusive.
    SubAppId No Integer VOD Application ID. Customers who activate VOD services from December 25, 2023, if they access resources in VOD applications (whether it is a default application or a newly created application), must fill in this field as the application ID.

    3. Output Parameters

    Parameter Name Type Description
    FileId String The unique identification of the media file of the fast edited video
    Url String Fast-edited media playback address
    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 Fast Clip Video

    Input Example

        
    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: FastEditMedia
    <Public Request Parameter>
    
    {
        "FileInfos": [{
            "EndTimeOffset": 0.0, 
            "StartTimeOffset": 30.0, 
            "AudioVideoType": "Original", 
            "TranscodeDefinition": 100210, 
            "FileId": "5285890784246869930"
        }]
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
            "FileId": "152854854879852xxxxx",
            "Url": "https://xxx.vod2.myqcloud.com/xxx/xxx.m3u8"
        }
    }
    

    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.
    InvalidParameterValue Incorrect parameter value.