Domain name for API request: vod.intl.tencentcloudapi.com.
Use the media processing capability of the media processing service (MPS) to initiate media processing for videos in video-on-demand.
Currently supported MPS features:
Video processing task initiated this method:
- Query task status and results on the VOD platform. Use DescribeTaskDetail or DescribeTasks to query tasks.
- The usage and bills of related features will be provided on the PS platform. Before using this feature, start by enabling Media Processing Service (MPS) in the console. For the activation method, see the preliminary operations in the access documentation.
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 identifier of the file in VOD, assigned by the VOD backend after successful upload. You can obtain this field in the video upload completion event notification or the 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) so that MPS video processing tasks can be initiated from the VOD side. For details on different types of video processing parameters, see Using MPS Media AI Capability. You can create a custom template through the CreateMPSTemplate API. |
| AiAnalysisTask | No | MPSAiAnalysisTaskInput | Parameters for the video content analysis task. Valid when MPSProcessMediaParams is empty. |
| SmartSubtitlesTask | No | MPSSmartSubtitlesTaskInput | Parameters for the intelligent subtitle type task. Valid when MPSProcessMediaParams is empty. |
| SmartEraseTask | No | MPSSmartEraseTaskInput | Task parameter of intelligent removal type. Valid when MPSProcessMediaParams is empty. |
| ExtInfo | No | String | Reserved field, used for special purposes. |
| 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 MPSProcessMediaParams to initiate 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 initiate 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 | VOD service is not enabled. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue.FileId | FileId does not exist. |
| InvalidParameterValue.SessionContextTooLong | SessionContext is too long. |
| InvalidParameterValue.SessionId | Duplicate recognition code. Request deduplicated. |
| InvalidParameterValue.SessionIdTooLong | SessionId is too long. |
| InvalidParameterValue.SubAppId | Parameter value error: app ID. |
| UnauthorizedOperation | Unauthorized operation. |
フィードバック