Release Notes
Announcements
Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to utilize the media processing capability of Media Processing Service (MPS) to initiate media processing for videos on VOD. When the task is initiated, relevant MPS parameters must be filled in the MPSProcessMediaParams parameter in JSON format. For detailed task parameter configuration, please refer to the ProcessMedia API.
Currently supported MPS features:
Media processing tasks initiated in this way:
- Task status and results are still queried on the on-demand platform. Use DescribeTaskDetail or DescribeTasks to query the task.
- Usage and billing for related functions will be provided on the MPS platform. Therefore, you must activate MPS service before using this feature.
- This feature is currently in internal testing. If you would like to test it, please contact us for support.
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, 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 | Yes | Integer | The VOD application ID. |
| MPSProcessMediaParams | Yes | String | This parameter is used for passing through to media processing service (MPS) so that video processing tasks can be triggered from VOD. For detailed information on video processing parameters, please refer to MPS Initiate Media Processing. Instructions: 1. Currently, only the AiAnalysisTask parameter in the MPS "ProcessMedia" API needs to be configured. Other parameters are not required. If other parameters are included, the system will automatically ignore them. 2. Currently, this is the only method used to initiate Smart Erase tasks. If parameters related to other task types are configured, the system will automatically ignore them. |
| 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. |
This example shows you how to trigger an intelligent erasure task for the video with fileId 5285485487985271487.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMediaByMPS
<Common request parameters>
{
"FileId": "5285485487985271487",
"SubAppId": 1500000001,
"MPSProcessMediaParams": "{\"AiAnalysisTask\": {\"Definition\":25,\"ExtendedParameter\":\"{\\\"delogo\\\":{\\\"cluster_id\\\":\\\"gpu_zhiyan\\\",\\\"CustomerAppId\\\":\\\"subtitle_erase_fast\\\"}}\"}}"
}{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TaskId": "125xxx65-ProcessMediaByMPS-bffb15f07530b57bc1aab01fac74bca"
}
}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. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback