Domain name for API request: vod.intl.tencentcloudapi.com.
Use the media processing capability of the media processing service to trigger media processing for on-demand video.
Video processing tasks initiated by this method:
Querying the status of tasks and results is still done on the VOD platform. Use DescribeTaskDetail or DescribeTasks to query tasks.
A maximum of 20 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: ProcessMediaByMPS. |
| 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, the globally unique ID of the file in VOD, is assigned by the VOD backend after successful upload. You can get this field in video upload completion event notification or VOD console. |
| SubAppId | Yes | Integer | VOD application ID. |
| MPSProcessMediaParams | No | String | Optional parameter. This parameter is used for passing through to the media processing service (MPS) to trigger MPS video processing tasks from VOD. |
| AiAnalysisTask | No | MPSAiAnalysisTaskInput | Parameters for the video content analysis task. Valid when MPSProcessMediaParams is empty. |
| SmartSubtitlesTask | No | MPSSmartSubtitlesTaskInput | Parameters for the smart subtitle task of type kind. Valid when MPSProcessMediaParams is empty. |
| SmartEraseTask | No | MPSSmartEraseTaskInput | Parameters for the intelligent erasure task of type kind. Valid when MPSProcessMediaParams is empty. |
| ExtInfo | No | String | Reserved field. Used for special purpose. |
| 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. |
Use the MPSProcessMediaParams parameter to trigger an intelligent analysis task
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMediaByMPS
<Common request parameters>
{
"FileId": "966263619095884274",
"SubAppId": 221157,
"MPSProcessMediaParams": "{\"AiAnalysisTask\":{\"Definition\": 21,\"ExtendedParameter\":\"\"}}"
}
{
"Response": {
"TaskId": "221157-ProcessMediaByMPS-c80d6b074ba566e4e4097bccc0044b9bt",
"RequestId": "4cc2a86b-7463-4ac2-9a32-e64882716f9e"
}
}
Use structured parameters to trigger an intelligent analysis task
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMediaByMPS
<Common request parameters>
{
"FileId": "966263619095884274",
"SubAppId": 221157,
"AiAnalysisTask": {
"Definition": 21,
"ExtendedParameter": ""
}
}
{
"Response": {
"TaskId": "221157-ProcessMediaByMPS-fd5bcd2cf2195fda7c7b571aa18cb68dt",
"RequestId": "c8bbd537-0815-4123-b284-8c1ee856bbe8"
}
}
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. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| 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: application id. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈