Domain name for API request: mps.tencentcloudapi.com.
This API is used to initiate a processing task for video URLs or media files in Cloud Object Storage (COS). Features include:
Video transcoding (standard transcoding, TSC transcoding, and audio/video enhancement);
Animated image generating;
Screenshot taking at specified time points;
Sampled screenshot taking;
Sprite screenshot taking;
Transcoding to adaptive bitrate streaming;
Intelligent auditing (porn detection and sensitive information detection);
Intelligent analysis (tagging, classification, thumbnail generating, frame-by-frame tagging, video splitting, highlights generating, opening and closing segments recognition, and game timestamping);
Intelligent identification (face, full text, text keyword, full speech, speech keyword, speech translation, and object recognition);
Media quality inspection (live stream format diagnosis, audio and video content detection (jitter, blur, low light, overexposure, black and white edges, black and white screens, screen glitch, noise, mosaic, QR code, and more), and no-reference scoring).
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: 2019-06-12. |
Region | No | String | Common Params. This parameter is not required for this API. |
InputInfo | Yes | MediaInputInfo | The information of the file to process. |
OutputStorage | No | TaskOutputStorage | The storage location of the media processing output file. If this parameter is left empty, the storage location in InputInfo will be inherited. |
OutputDir | No | String | The directory to save the media processing output file, which must start and end with / , such as /movie/201907/ .If you do not specify this parameter, the file will be saved to the directory specified in InputInfo . |
ScheduleId | No | Integer | Orchestration ID. Note 1: For parameters OutputStorage and OutputDir: Note 2: For the TaskNotifyConfig parameter, if the task creation API (ProcessMedia) has set this parameter, it will override the default callback of the original orchestration. Note 3: The trigger configured for an orchestration is for automatically starting the orchestration. It stops working when you manually call this API to start an orchestration. |
MediaProcessTask | No | MediaProcessTaskInput | The media processing parameters to use. |
AiContentReviewTask | No | AiContentReviewTaskInput | Type parameter of a video content audit task. |
AiAnalysisTask | No | AiAnalysisTaskInput | Video content analysis task parameter. |
AiRecognitionTask | No | AiRecognitionTaskInput | Type parameter of a video content recognition task. |
AiQualityControlTask | No | AiQualityControlTaskInput | Media quality inspection type task parameters. |
TaskNotifyConfig | No | TaskNotifyConfig | Event notification information of a task. If this parameter is left empty, no event notifications will be obtained. |
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. |
SessionId | No | String | Identification code for deduplication, up to 50 characters. If a request with the same identification code was made within the past 3 days, an error will be returned for the current request. If this parameter is not provided or is an empty string, deduplication will not be performed for this request. |
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. |
TaskType | No | String | The task type.Online (default): A task that is executed immediately.Offline : A task that is executed when the system is idle (within three days by default). |
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 initiate a transcoding task for a COS endpoint to transcode videos according to the transcoding templates 20, 30, and 40.
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMedia
<Common request parameters>
{
"MediaProcessTask": {
"TranscodeTaskSet": [
{
"Definition": "30"
},
{
"Definition": "20"
},
{
"Definition": "40"
}
]
},
"InputInfo": {
"Type": "COS",
"CosInputInfo": {
"Region": "ap-chongqing",
"Object": "/movie/201907/WildAnimal.mov",
"Bucket": "TopRankVideo-125xxx88"
}
}
}
{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TaskId": "125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca"
}
}
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.GenerateResource | Resource generation failed. |
FailedOperation.InvalidMpsUser | Operation failed: unauthorized MPS user. |
InternalError | Internal error. |
InvalidParameter | Parameter error. |
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. |
Was this page helpful?