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:
If event notifications are used, the event type is ProcedureStateChanged.
A maximum of 100 requests can be initiated per second for this API.
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. |
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. |
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. |
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. |
This example shows you how to initiate a transcoding task for the video whose fileId
is 5285485487985271487
to output in three specifications with transcoding templates (IDs: 20, 30, and 40).
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>
{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TaskId": "125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca"
}
}
This example shows you how to initiate a transcoding task for the video whose fileId
is 5285485487985271487
to output in three specifications using transcoding templates (IDs: 20, 30, and 40), and watermark the output videos using a watermark template (ID: 15780).
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>
{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TaskId": "125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca"
}
}
This example shows you how to initiate a transcoding task for the video whose fileId
is 5285485487985271487
to output in three specifications with transcoding templates (IDs: 20, 30, and 40), and take video screenshots using a sampled screenshot template (ID: 10).
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>
{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TaskId": "125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca"
}
}
This example shows you how to initiate a task to recognize pornographic, terrorism, and politically sensitive content in the video whose fileId
is 5285485487985271487
using an intelligent recognition template (ID: 10).
https://vod.tencentcloudapi.com/?Action=ProcessMedia
&FileId=5285485487985271487
&AiContentReviewTask.Definition=10
&<Common request parameters>
{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TaskId": "125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca"
}
}
This example shows you how to initiate a content analysis task (including intelligent categorization, label detection, and thumbnail generation) for the video whose fileId
is 5285485487985271487
using a content analysis template (ID: 10).
https://vod.tencentcloudapi.com/?Action=ProcessMedia
&FileId=5285485487985271487
&AiAnalysisTask.Definition=10
&<Common request parameters>
{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TaskId": "125xxx65-procedurev2-bffb15f07586237bcecodb01fac7kdikk"
}
}
This example shows you how to initiate a content recognition task (including face recognition) for the video whose fileId
is 5285485487985271487
using a content recognition template (ID: 10).
https://vod.tencentcloudapi.com/?Action=ProcessMedia
&FileId=5285485487985271487
&AiRecognitionTask.Definition=10
&<Common request parameters>
{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc70006fje1",
"TaskId": "125xxx65-procedurev2-bffb15f07586237bcecodb01fac7kdabc"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?