tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ProcessMedia

Last updated: 2024-04-18 13:34:54

    1. API Description

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

    Initiate processing tasks for media file in VOD, including:

    1. Video transcoding (with Watermark);
    2. Video to animated image;
    3. Screencapturing the video at specified Time point;
    4. Sampled screenshot of the video;
    5. Generated Image sprite template from the video;
    6. Generated a cover image from the video;
    7. Adaptive Bitrate Streaming for the video (with encryption);
    8. Content Moderation (offensive Information, unsafe Information, inappropriate Information), it is not recommended to use this API, recommend using Video moderation(ReviewAudioVideo) or Image moderation(ReviewImage);
    9. Content analysis (tag, category, cover, frame-by-frame tag);
    10. Content recognition (video intro and outro, face, Text, keyword, voice, Key object).

    If using event notification, the event notification type is task flow status change.

    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: ProcessMedia.
    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 Media file ID, i.e., the globally unique ID of a file in VOD assigned by the VOD backend after successful upload. This field can be obtained through the video upload completion event notification or VOD Console.
    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.
    MediaProcessTask No MediaProcessTaskInput Parameter of video processing task.
    AiContentReviewTask No AiContentReviewTaskInput The information of the audio/video moderation task*.
    This parameter is *no longer recommended. Please use ReviewAudioVideo or ReviewImage instead.
    AiAnalysisTask No AiAnalysisTaskInput Video content analysis task parameter.
    AiRecognitionTask No AiRecognitionTaskInput Type parameter of video content recognition task.
    TasksPriority No Integer Task flow priority. The higher the value, the higher the priority. Value range: -10-10. If this parameter is left empty, 0 will be used.
    TasksNotifyMode No String Notification mode for task flow status change. Valid values: Finish, Change, None. If this parameter is left empty, Finish will be used.
    SessionContext No String The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters.
    SessionId No String Used to identify duplicate requests. After you send a request, if any request with the same SessionId has already been sent in the last three days (72 hours), an error message will be returned. SessionId contains up to 50 characters. If this parameter is not carried or is an empty string, no deduplication will be performed.
    ExtInfo No String Reserved field for special purposes.

    3. Output Parameters

    Parameter Name Type Description
    TaskId String Task ID
    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 Initiate a transcoding task

    Initiate a transcoding task for the video with fileId 5285485487985271487, and export three specifications. The transcoding template IDs used are 20, 30, and 40.

    Input Example

    POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMedia
<Public Request Parameter>

{
    "MediaProcessTask": {
        "TranscodeTaskSet": [
            {
                "Definition": 30
            },
            {
                "Definition": 20
            },
            {
                "Definition": 40
            }
        ]
    },
    "FileId": "5285485487985271487"
}

    Output Example

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

    Example2 Initiate a watermarked transcoding task

    Initiate a transcoding task for the video with fileId 5285485487985271487, and export three specifications. The transcoding template IDs used are 20, 30, and 40 respectively; and all transcoded videos are watermarked, and the template ID of the watermark is 15780.

    Input Example

    POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMedia
<Public Request Parameter>

{
    "MediaProcessTask": {
        "TranscodeTaskSet": [
            {
                "Definition": 30,
                "WatermarkSet": [
                    {
                        "Definition": 15780
                    }
                ]
            },
            {
                "Definition": 20,
                "WatermarkSet": [
                    {
                        "Definition": 15780
                    }
                ]
            },
            {
                "Definition": 40,
                "WatermarkSet": [
                    {
                        "Definition": 15780
                    }
                ]
            }
        ]
    },
    "FileId": "5285485487985271487"
}

    Output Example

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

    Example3 Initiate transcoding and sampling screenshot tasks

    Initiate a transcoding task for the video with fileId 5285485487985271487, and export three specifications. The transcoding template IDs used are 20, 30, and 40 respectively. At the same time, sample screenshots are also taken of the video, and the template ID of the sample screenshots used is 10.

    Input Example

    POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMedia
<Public Request Parameter>

{
    "MediaProcessTask": {
        "TranscodeTaskSet": [
            {
                "Definition": 30
            },
            {
                "Definition": 20
            },
            {
                "Definition": 40
            }
        ],
        "SampleSnapshotTaskSet": [
            {
                "Definition": 10
            }
        ]
    },
    "FileId": "5285485487985271487"
}

    Output Example

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

    Example4 Initiate an intelligent content analysis task

    Initiate a content analysis task (including smart classification, smart label, smart cover) for the video with fileId 5285485487985271487. The content analysis template ID used is 10.

    Input Example

    POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMedia
<Public Request Parameter>

{
    "AiAnalysisTask": {
        "Definition": 10
    },
    "FileId": "5285485487985271487"
}

    Output Example

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

    Example5 Initiate a content review task

    Initiate a content review task (offensive information, unsafe information, inappropriate information) for the video with fileId 5285485487985271487. The content review template ID used is 10.

    Input Example

    POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMedia
<Public Request Parameter>

{
    "AiContentReviewTask": {
        "Definition": 10
    },
    "FileId": "5285485487985271487"
}

    Output Example

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

    Example6 Initiate a content identification task

    Initiate a content recognition task (including face recognition) on the video with fileId 5285485487985271487, and use the content recognition template ID 10.

    Input Example

    POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMedia
<Public Request Parameter>

{
    "AiRecognitionTask": {
        "Definition": 10
    },
    "FileId": "5285485487985271487"
}

    Output Example

    {
    "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc70006fje1",
        "TaskId": "125xxx65-procedurev2-bffb15f07586237bcecodb01fac7kdabc"
    }
}

    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.
    FailedOperation.NoNeedToReduceMediaBitrate No need to reduce the bitrate.
    FailedOperation.TaskDuplicate Operation failed: the task already exists.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.AiAnalysisTaskDefinition Incorrect parameter value: Definition for AI-based analysis.
    InvalidParameterValue.AiContentReviewTaskDefinition Incorrect parameter value: Definition AI-based content audit.
    InvalidParameterValue.AiRecognitionTaskDefinition Incorrect parameter value: Definition for AI-based recognition.
    InvalidParameterValue.FileId The FileId does not exist.
    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
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy