EditMedia
1. API Description
Domain name for API request: mps.tencentcloudapi.com.
This API is used to edit a video to generate a new video. Editing actions may include:
Simple editing: Simple video editing such as clipping and splicing
1.1 Clipping a file to generate a new video
1.2 Splicing multiple files to generate a new video
1.3 Clipping multiple files and then splicing the clips to generate a new videoCompositing: Composing a new video as required
2.1 Adding different tracks (video, audio, subtitles) or elements (video, image, audio, text, empty)
2.2 Image: Adding, scaling, rotating, or mirroring an image
2.3 Audio: Adjusting volume and adding audio effects such as fade and reverb
2.4 Video: Adding transition effects, changing playback speed, splicing and clipping videos, adding subtitles, playing videos picture-in-picture, separating audio from videos, adding animation effects, etc.
A maximum of 20 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: EditMedia. |
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. |
FileInfos.N | Yes | Array of EditMediaFileInfo | Information of input video file. |
OutputStorage | Yes | TaskOutputStorage | The storage location of the media processing output file. |
OutputObjectPath | Yes | String | The path to save the media processing output file. Note: For complex compositing tasks, the filename can be up to 64 characters long and can only contain digits, letters, and special characters -_ |
OutputConfig | No | EditMediaOutputConfig | The output settings for a video clipping task. |
ComposeConfig | No | ComposeMediaConfig | The settings for a video compositing task. Note: If this parameter is not empty, the task is a video compositing task. Otherwise, the task is a video clipping task. |
TaskNotifyConfig | No | TaskNotifyConfig | Event notification information of task. If this parameter is left empty, no event notifications will be obtained. |
TasksPriority | No | Integer | Task 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. |
3. Output Parameters
Parameter Name | Type | Description |
---|---|---|
TaskId | String | Video editing task ID, which can be used to query the status of an editing task. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Clipping a file to generate a new video
Input Example
https://mps.tencentcloudapi.com/?Action=EditMedia
&FileInfos.0.InputInfo.Type=COS
&FileInfos.0.InputInfo.CosInputInfo.Bucket=TopRankVideo-125xxx88
&FileInfos.0.InputInfo.CosInputInfo.Region=ap-chongqing
&FileInfos.0.InputInfo.CosInputInfo.Object=/movie/201907/WildAnimal.mov
&FileInfos.0.StartTimeOffset=60.0
&FileInfos.0.EndTimeOffset=120.0
&OutputStorage.Type=COS
&OutputStorage.CosOutputStorage.Bucket=TopRankVideo-125xxx88
&OutputStorage.CosOutputStorage.Region=ap-chongqing
&OutputObjectPath=/clip_result/clip_WildAnimal.{format}
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TaskId": "125xxx88-EditMedia-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. |