ProduceEditingProjectVideo - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Operation description

Before you use this operation, make sure that you fully understand the billing methods and pricing of ApsaraVideo VOD. Online editing is a paid feature. For more information about billing, see Billing for video editing and production.
This operation returns the result of the task submission. A successful response indicates that the task was submitted, but does not guarantee that the video has been produced. The production task is added to a queue and runs asynchronously in the background.
The video resources used in the online editing timeline can be materials from Material Management or videos from the Media Library. If you use videos from the Media Library, make sure their status is Normal.
Video production is based on ProjectId and Timeline. The logic is as follows:
- ProjectId and Timeline cannot both be empty. Otherwise, the video cannot be produced.
- If ProjectId is empty and Timeline is not empty, an online editing project is automatically created. The specified Timeline is used as the timeline for the project. The materials referenced in the Timeline are fetched and set as the materials for the project. Then, the video is produced.
- If ProjectId is not empty and Timeline is empty, the latest saved timeline for the specified ProjectId is retrieved and used for video production.
- If both ProjectId and Timeline are not empty, the video is produced based on the specified Timeline. The timeline and materials of the corresponding online editing project are also updated. If you specify other fields, the corresponding fields of the online editing project are updated.
The number of video tracks, image tracks, and caption tracks is limited to 100 for each type.
The total number of materials cannot exceed 200. The total size of material files cannot exceed 1 TB.
The region of the input or output bucket must be the same as the region where you use the VOD service.
The resolution of the output video is subject to the following limits:
- The width and height cannot be less than 128 pixels.
- The width and height cannot be greater than 4096 pixels.
- The shorter side cannot be greater than 2160 pixels.
After a video is produced, it is automatically uploaded to ApsaraVideo VOD. After the video production is complete, the VOD service sends Media Production Complete and Video Upload Complete event notifications. After the produced video is transcoded, the service sends Single Definition Transcoding Complete and All Definitions Transcoding Complete event notifications.
You can also add effects to the produced video. For more information, see Effects.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:ProduceEditingProjectVideo

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	string	No	The ID of the online editing project. You can obtain the ID in the following ways: Log on to the ApsaraVideo VOD console. In the navigation pane, choose Production Center > Video Editing. View the ID. The value of the ProjectId parameter that is returned after you call the CreateEditingProject operation.	fb2101bf24b4cb318787dc****
Timeline	string	No	The timeline of the online editing project, in JSON format. For more information about the structure, see Timeline. Note Make sure that each VideoTrackClip object contains a valid MediaId. Otherwise, the request fails.	{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"cc3308ac59615a54328bc3443**"},{"MediaId":"da87a9cff645cd88bc6d8326e4**"}]}]}
Title	string	No	The title of the online editing project.	Cloud Clip Project Title
Description	string	No	The description of the online editing project.	Cloud clip project description
CoverURL	string	No	The thumbnail of the online editing project.	https://example.aliyundoc.com/6AB4D0E1E1C7446888351****.png
MediaMetadata	string	No	The metadata of the produced video, in JSON format. For more information about the structure, see MediaMetadata.	{"Description":"Synthetic Video Description","Title":"Synthetic userData test"}
ProduceConfig	string	No	The production configuration, in JSON format. For more information about the structure, see ProduceConfig. Important The StorageLocation field can be ignored if the storage region is China (Shanghai). This field is required if the storage region is another region.	{"TemplateGroupId":"6d11e25ea30a4c465435c74****"}
UserData	string	No	The custom settings. This is a JSON string that can be up to 256 characters in length. It supports settings such as message callbacks. For more information about the structure, see UserData. Note To use the message callback feature in this parameter, you must configure a webhook address and select the corresponding event types in the console. Otherwise, the callback settings do not take effect.	{"Extend":{"width":1280,"id":"028a8e56b1ebf6bb7afc74****","height":720},"MessageCallback":{"CallbackURL":"https://example.aliyundoc.com/2016-08-15/proxy/httpcallback/testcallback/","CallbackType":"http"}}
AppId	string	No	The application ID. The default value is app-1000000. For more information, see Multi-application service.	app-****

Response elements

Element	Type	Description	Example
	object	The response that is returned.
RequestId	string	The ID of the request.	25818875-5F78-4AF6-D7393642CA58****
MediaId	string	The ID of the produced video. Note This operation synchronously returns the ID of the video to be produced. A returned MediaId indicates that the video production task has been submitted for asynchronous processing.	006204a11bb386bb25491f95f****
ProjectId	string	The ID of the online editing project.	fb2101bf24b4cb318787dc****

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "MediaId": "006204a11bb386bb25491f95f****",
  "ProjectId": "fb2101bf24b4cb318787dc****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.