ProcessMedia

Last updated: 2020-08-14 09:40:38

1. API Description

Domain name for API request: mps.tencentcloudapi.com.

This API is used to initiate a processing task for media files in COS, including:

  1. Video transcoding (with watermark);
  2. Animated image generating;
  3. Time point screencapturing;
  4. Sampled screencapturing;
  5. Image sprite generating;
  6. Video conversion to adaptive bitrate streaming;
  7. Intelligent content audit (detection of porn, terrorism, and politically sensitive information);
  8. Intelligent content recognition (face recognition, full text recognition, text keyword recognition, full speech recognition, and speech keyword recognition).

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 parameter. The value used for this API: ProcessMedia.
Version Yes String Common parameter. The value used for this API: 2019-06-12.
Region No String Common parameter. This parameter is not required for this API.
InputInfo Yes MediaInputInfo Input information of a file for video processing.
OutputStorage No TaskOutputStorage Target bucket of a video processing output file. If this parameter is left empty, the storage location in InputInfo will be inherited.
OutputDir No String Target directory of a video processing output file, such as /movie/201907/. If this parameter is left empty, the file will be outputted to the same directory as that in InputInfo.
MediaProcessTask No MediaProcessTaskInput Parameter of a video processing task.
AiContentReviewTask No AiContentReviewTaskInput Type parameter of a video content audit task.
AiAnalysisTask No AiAnalysisTaskInput
AiRecognitionTask No AiRecognitionTaskInput Type parameter of a video content recognition 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 seven 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.

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 transcoding task

This example shows you how to initiate a transcoding task for a video at a specified COS address to output in three formats of 20, 30, and 40.

Input Example

https://mps.tencentcloudapi.com/?Action=ProcessMedia
&InputInfo.Type=COS
&InputInfo.CosInputInfo.Bucket=TopRankVideo-125xxx88
&InputInfo.CosInputInfo.Region=ap-chongqing
&InputInfo.CosInputInfo.Object=/movie/201907/WildAnimal.mov
&MediaProcessTask.TranscodeTaskSet.0.Definition=20
&MediaProcessTask.TranscodeTaskSet.1.Definition=30
&MediaProcessTask.TranscodeTaskSet.2.Definition=40
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
    "TaskId": "125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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
InvalidParameterValue.SessionId
InvalidParameterValue.SessionIdTooLong

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help