tencent cloud

文档反馈

ProcessMedia

最后更新时间:2022-08-23 16:02:40

1. API Description

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

This API is used to initiate a media processing task on a VOD file. The task may include:

  1. Video transcoding (with watermark)
  2. Animated image generating
  3. Time point screenshot
  4. Sampled screenshot
  5. Image sprite generating
  6. Taking a screenshot to use as the thumbnail
  7. Adaptive bitrate streaming and encryption
  8. Intelligent recognition of pornographic, terrorism, and politically sensitive content
  9. Intelligent content analysis for labeling, categorization, thumbnail generation, or frame-specific labeling
  10. Recognition of opening and closing credits, faces, full text, text keywords, full speech, speech keywords, and objects

If event notifications are used, the event type is ProcedureStateChanged.

A digital watermark has the following restrictions:

  • Digital watermarks can only be image watermarks.
  • Digital watermarks must be looped.
  • If you use digital watermarks, the output video must be in HLS format.
  • Digital watermarks can only be displayed in the upper half of a video.
  • 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 for this API.
    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 subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.
    MediaProcessTask No MediaProcessTaskInput Parameter of video processing task.
    AiContentReviewTask No AiContentReviewTaskInput Parameters for intelligent recognition
    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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Initiating a transcoding task

    This example shows you how to initiate a task to transcode the video whose fileId is 5285485487985271487 according to the transcoding templates 20, 30, and 40.

    Input Example

    https://vod.tencentcloudapi.com/?Action=ProcessMedia
    &FileId=5285485487985271487
    &MediaProcessTask.TranscodeTaskSet.0.Definition=20
    &MediaProcessTask.TranscodeTaskSet.1.Definition=30
    &MediaProcessTask.TranscodeTaskSet.2.Definition=40
    &<Common request parameters>
    

    Output Example

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

    Example2 Initiating a transcoding task with watermarked outputs

    This example shows you how to initiate a task to transcode the video whose fileId is 5285485487985271487 according to the transcoding templates 20, 30, and 40, as well as watermark the videos according to the watermark template 15780.

    Input Example

    https://vod.tencentcloudapi.com/?Action=ProcessMedia
    &FileId=5285485487985271487
    &MediaProcessTask.TranscodeTaskSet.0.Definition=20
    &MediaProcessTask.TranscodeTaskSet.0.WatermarkSet.0.Definition=15780
    &MediaProcessTask.TranscodeTaskSet.1.Definition=30
    &MediaProcessTask.TranscodeTaskSet.1.WatermarkSet.0.Definition=15780
    &MediaProcessTask.TranscodeTaskSet.2.Definition=40
    &MediaProcessTask.TranscodeTaskSet.2.WatermarkSet.0.Definition=15780
    &<Common request parameters>
    

    Output Example

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

    Example3 Initiating a task to transcode a video and take sampled screenshots

    This example shows you how to initiate a task to transcode the video whose fileId is 5285485487985271487 according to the transcoding templates 20, 30, and 40, and take screenshots according to the sampled screenshot template 10.

    Input Example

    https://vod.tencentcloudapi.com/?Action=ProcessMedia
    &FileId=5285485487985271487
    &MediaProcessTask.TranscodeTaskSet.0.Definition=20
    &MediaProcessTask.TranscodeTaskSet.1.Definition=30
    &MediaProcessTask.TranscodeTaskSet.2.Definition=40
    &MediaProcessTask.SampleSnapshotTaskSet.0.Definition=10
    &<Common request parameters>
    

    Output Example

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

    Example4 Initiating an intelligent content analysis task

    This example shows you how to initiate task to analyze the video whose fileId is 5285485487985271487 according to the content analysis template 10 for intelligent categorization, label detection, and thumbnail generation.

    Input Example

    https://vod.tencentcloudapi.com/?Action=ProcessMedia
    &FileId=5285485487985271487
    &AiAnalysisTask.Definition=10
    &<Common request parameters>
    

    Output Example

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

    Example5 Initiating an intelligent recognition task

    This example shows you how to initiate a task to recognize pornographic, terrorist, and politically sensitive content in the video whose fileId is 5285485487985271487 according to the intelligent recognition template 10.

    Input Example

    https://vod.tencentcloudapi.com/?Action=ProcessMedia
    &FileId=5285485487985271487
    &AiContentReviewTask.Definition=10
    &<Common request parameters>
    

    Output Example

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

    Example6 Initiating an intelligent content recognition task

    This example shows you how to initiate a task to recognize faces in the video whose fileId is 5285485487985271487 according to the content recognition template 10.

    Input Example

    https://vod.tencentcloudapi.com/?Action=ProcessMedia
    &FileId=5285485487985271487
    &AiRecognitionTask.Definition=10
    &<Common request parameters>
    

    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.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.
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持