tencent cloud

Feedback

SplitMedia

Last updated: 2024-03-27 16:09:41

    1. API Description

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

    Split the video into strips to generate multiple new videos.

    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: SplitMedia.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    FileId Yes String The video ID.
    Segments.N Yes Array of SplitMediaTaskConfig Video splitting task information list, supporting up to 100 splitting messages at the same time.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    SessionContext No String Identifies the source context, which is used to transparently transmit user request information. This field value will be returned in the SplitMediaComplete callback and task flow status change callback, with a maximum length of 1000 characters.
    SessionId No String The identification code used for task deduplication. If there is a request with the same identification code within three days, this request will return an error. The maximum length is 50 characters, without or with an empty string to indicate no deduplication.
    TasksPriority No Integer The priority of the task. The larger the value, the higher the priority. The value range is -10 to 10. If left blank, it means 0.

    3. Output Parameters

    Parameter Name Type Description
    TaskId String The task ID of video splitting. You can use this ID to query the status of the splitting task (task type is SplitMedia).
    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 Split the video file into two new videos

    Input Example

    https://vod.tencentcloudapi.com/?Action=SplitMedia
    &FileId=5285485487985271487
    &Segments.0.StartTimeOffset=40.0
    &Segments.0.EndTimeOffset=50.0
    &Segments.1.StartTimeOffset=60.0
    &Segments.1.EndTimeOffset=70.0
    &<Public Request Parameter>
    

    Output Example

    {
        "Response": {
            "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
            "TaskId": "125xxx65-SplitMedia-bffb15f07530b57bc1aabb01fac74bca"
        }
    }
    

    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.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InvalidParameterValue.SessionContextTooLong SessionContext is too long.
    InvalidParameterValue.SessionId The deduplication ID already exists. The request is removed due to duplication.
    InvalidParameterValue.SessionIdTooLong SessionId is too long.
    InvalidParameterValue.SubAppId Incorrect parameter value: subapplication ID
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation Unauthorized operation.