tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

EditMedia

Last updated: 2024-03-27 16:08:33

    1. API Description

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

    Edit the video (cut, splice, etc.) to generate a new video. The editing functions include:

    1. Edit a file in the VOD video to generate a new video;
    2. Splice multiple files to generate a new video;
    3. Edit multiple files and then splice them to generate a new video;
    4. Directly generate a new video for a stream;
    5. Edit a stream to generate a new video. Video;
    6. Splice multiple streams to generate a new video;
    7. Clip and then splice multiple streams to generate a new video.

    For the generated new video, you can also specify whether the generated video needs to execute the task flow.

    When editing or splicing live streams, please make sure to do so after the stream is over. Otherwise the resulting video may be incomplete.

    If event notification is used, the type of event notification is Video editing completed.

    A maximum of 100 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: EditMedia.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    InputType Yes String Input the type of video. The possible values u200bu200bare File and Stream.
    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.
    FileInfos.N No Array of EditMediaFileInfo Input video file information, required when InputType is File.
    StreamInfos.N No Array of EditMediaStreamInfo nput stream information, required when InputType is Stream.
    Definition No Integer EditMedia template ID. The values u200bu200bare 10 and 20. If left blank, the 10 template is used.
  • 10: When splicing, the input with the highest resolution is used as the benchmark;
  • 20: When splicing, the input with the highest code rate is used as the benchmark.
    • ProcedureName No String Task flow template name, if you want Fill in when executing the task flow on the generated new video.
    OutputConfig No EditMediaOutputConfig The file configuration generated after editing.
    SessionContext No String Identifies the source context, which is used to transparently transmit user request information. This field value will be returned in the EditMediaComplete callback and task flow status change callback, with a maximum length of 1000 characters.
    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.
    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.
    ExtInfo No String Reserved fields, used for special purposes.

    3. Output Parameters

    Parameter Name Type Description
    TaskId String The task ID of the video editing. You can use this ID to query the status of the editing task (task type is EditMedia).
    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 Edit a file to generate a new video

    Edit the clip from 60 seconds to 120 seconds of 5285485487985271487 to generate a new on-demand video

    Input Example

    https://vod.tencentcloudapi.com/?Action=EditMedia
&InputType=File
&FileInfos.0.FileId=5285485487985271487
&FileInfos.0.StartTimeOffset=60.0
&FileInfos.0.EndTimeOffset=120.0
&<Public Request Parameter>

    Output Example

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

    Example2 Splice multiple files to generate a new video

    Splice three videos 5285485487985271487, 5285485487985271488, 5285485487985271489 to generate a new on-demand video

    Input Example

    https://vod.tencentcloudapi.com/?Action=EditMedia
&InputType=File
&FileInfos.0.FileId=5285485487985271487
&FileInfos.1.FileId=5285485487985271488
&FileInfos.2.FileId=5285485487985271489
&<Public Request Parameter>

    Output Example

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

    Example3 Edit multiple files and then splice them together to generate a new video

    Edit the three videos 5285485487985271487, 5285485487985271488, 5285485487985271489 respectively (edit the clips from 60 seconds to 120 seconds), and then splice them together to generate a new on-demand video

    Input Example

    https://vod.tencentcloudapi.com/?Action=EditMedia
&InputType=File
&FileInfos.0.FileId=5285485487985271487
&FileInfos.0.StartTimeOffset=60.0
&FileInfos.0.EndTimeOffset=120.0
&FileInfos.1.FileId=5285485487985271488
&FileInfos.1.StartTimeOffset=60.0
&FileInfos.1.EndTimeOffset=120.0
&FileInfos.2.FileId=5285485487985271489
&FileInfos.2.StartTimeOffset=60.0
&FileInfos.2.EndTimeOffset=120.0
&<Public Request Parameter>

    Output Example

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

    Example4 For a stream, directly generate a new video

    Generate a new on-demand video for a live recording stream with ID 99873

    Input Example

    https://vod.tencentcloudapi.com/?Action=EditMedia
&InputType=Stream
&StreamInfos.0.StreamId=99873
&<Public Request Parameter>

    Output Example

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

    Example5 Clip a stream to generate a new video

    For a live recording stream with ID 99873, edit the clips from 10:00:00 to 11:00:00 on 2018-09-20 to generate a new on-demand video

    Input Example

    https://vod.tencentcloudapi.com/?Action=EditMedia
&InputType=Stream
&StreamInfos.0.StreamId=99873
&StreamInfos.0.StartTime=2018-09-20T10:00:00Z
&StreamInfos.0.EndTime=2018-09-20T11:00:00Z
&<Public Request Parameter>

    Output Example

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

    Example6 Splice multiple streams to generate a new video

    Splice the three live recording streams with IDs 99873, 99874 and 99875 to generate a new on-demand video

    Input Example

    https://vod.tencentcloudapi.com/?Action=EditMedia
&InputType=Stream
&StreamInfos.0.StreamId=99873
&StreamInfos.1.StreamId=99874
&StreamInfos.2.StreamId=99875
&<Public Request Parameter>

    Output Example

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

    Example7 Edit multiple streams in the on-demand video and then splice them together to generate a new video

    Cut out the three live recording streams with IDs 99873, 99874 and 99875, respectively, from 10:00:00 to 11:00:00 on 2018-09-20, and splice them to generate a new on-demand video.

    Input Example

    https://vod.tencentcloudapi.com/?Action=EditMedia
&InputType=Stream
&StreamInfos.0.StreamId=99873
&StreamInfos.0.StartTime=2018-09-20T10:00:00Z
&StreamInfos.0.EndTime=2018-09-20T11:00:00Z
&StreamInfos.1.StreamId=99874
&StreamInfos.1.StartTime=2018-09-20T10:00:00Z
&StreamInfos.1.EndTime=2018-09-20T11:00:00Z
&StreamInfos.2.StreamId=99875
&StreamInfos.2.StartTime=2018-09-20T10:00:00Z
&StreamInfos.2.EndTime=2018-09-20T11:00:00Z
&<Public Request Parameter>

    Output Example

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

    Example8 Edit a file, generate a new video, and execute the task flow on the new video.

    Edit the clip from 60 seconds to 120 seconds of 5285485487985271487, generate a new on-demand video, and execute the task flow TranscodeAndSnapshot

    Input Example

    https://vod.tencentcloudapi.com/?Action=EditMedia
&InputType=File
&FileInfos.0.FileId=5285485487985271487
&FileInfos.0.StartTimeOffset=60.0
&FileInfos.0.EndTimeOffset=120.0
&ProcedureName=TranscodeAndSnapshot
&<Public Request Parameter>

    Output Example

    {
    "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
        "TaskId": "125xxx65-clipMedia-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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy