ProcessMedia
1. API Description
Domain name for API request: mps.tencentcloudapi.com.
This API is used to initiate processing tasks for media specified by a URL or in COS. Such tasks may include the following:
- Video transcoding (general transcoding, Top Speed Codec, audio/video enhancement)
- Animated image generating
- Time point screencapturing
- Sampled screencapturing
- Image sprite generating
- Adaptive bitrate streaming
- Intelligent content moderation (detection of pornographic and sensitive content)
- Intelligent content analysis (labeling, categorization, thumbnail generation, labeling by frame, splitting, highlight generation, opening and closing segment recognition)
- Intelligent content recognition (face, full text, text keyword, full speech, speech keyword, speech translation, object recognition)
A maximum of 100 requests can be initiated per second for this API.
2. Input Parameters
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 | The scheme ID. Note 1: About OutputStorage and OutputDir ProcessMedia API will be applied.Note 2: If TaskNotifyConfig is specified, the specified settings will be used instead of the default callback settings of the scheme.Note 3: The trigger configured for a scheme is for automatically starting a scheme. It stops working when you manually call this API to start a scheme. |
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 | The parameters of a quality control task. |
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 | The ID used for deduplication. If there was a request with the same ID in the last three days, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or an empty string is entered, no deduplication will be performed. |
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). |
3. Output Parameters
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. |
4. Example
Example1 Initiating a transcoding task
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.
Input Example
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"
}
}
}
Output Example
{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TaskId": "125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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.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. |