ProcessMedia

Last updated: 2020-03-27 18:45:24

1. API Description

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

This API is used to initiate a processing task for an audio/video media file in VOD, including:

  1. Video transcoding (with watermark);
  2. Animated image generating;
  3. Time point screencapturing;
  4. Sampled screencapturing;
  5. Image sprite generating;
  6. Cover generating by screencapturing;
  7. Adaptive bitrate streaming (with encryption);
  8. Intelligent content audit (detection of porn, terrorism, and politically sensitive information);
  9. Intelligent content analysis (tag, category, cover, and frame-specific tag);
  10. Intelligent content recognition (opening and closing credits, face, full text, text keyword, full speech, speech keyword, and object).

A maximum of 100 requests can be initiated per second for this API.

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 parameter. The value used for this API: ProcessMedia.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region No String Common parameter. 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.
MediaProcessTask No MediaProcessTaskInput Parameter of video processing task.
AiContentReviewTask No AiContentReviewTaskInput Type parameter of video content audit task.
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 The ID used for deduplication. If there was a request with the same ID in the last seven days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or a blank string is entered, no deduplication will be performed.
ExtInfo No String Reserved field for special purposes.
SubAppId No Integer Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

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 transcoding task for the video with the fileId of 5285485487985271487 to output in three specifications with transcoding template IDs 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 watermark

This example shows you how to initiate a transcoding task for the video with the fileId of 5285485487985271487 to output in three specifications with transcoding template IDs 20, 30, and 40. All the output videos are watermarked with the watermarking template ID 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 transcoding and sampled screencapturing task

This example shows you how to initiate a transcoding task for the video with the fileId of 5285485487985271487 to output in three specifications with transcoding template IDs 20, 30, and 40, and screencapture the video with sampled screencapturing template ID 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 audit task

This example shows you how to initiate an intelligent content audit task (including detection of porn, politically sensitive, and terrorism information) for the video with fileId of 5285485487985271487 by using content audit template ID 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"
  }
}

Example5 Initiating an intelligent content analysis task

This example shows you how to initiate a content analysis task (including intelligently generating category, tag, and cover) for the video with fileId of 5285485487985271487 by using content analysis template ID 10.

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"
  }
}

Example6 Initiating an intelligent content recognition task

This example shows you how to initiate a content recognition task (including face recognition) for the video with fileId of 5285485487985271487 by using content recognition template ID 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

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.TaskDuplicate Operation failed: the task already exists.
InternalError Internal error.
InvalidParameter Invalid parameter.
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.