Description
You can call this operation to produce a finished resource based on one or more videos. You can directly submit video mezzanine files by specifying the timeline parameters. Alternatively, you can create an online editing project and submit the prepared timeline for video production.
Note: This operation only returns the submission result of a video production task. It does not guarantee that video production has been completed when the operation result is returned. The video production task is queued in the background for asynchronous processing.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Action | String | Yes | The operation that you want to perform. Set this parameter to ProduceEditingProjectVideo. |
| ProjectId | String | No | The ID of the online editing project. |
| Timeline | String | No | The timeline of the online editing project, in JSON format. For more information about the structure, see Timeline. |
| Title | String | No | The title of the online editing project. |
| Description | String | No | The description of the online editing project. |
| CoverURL | String | No | The thumbnail URL of the online editing project. |
| MediaMetadata | String | No | The metadata of the produced video, in JSON format. For more information about the structure, see MediaMetadata. |
| ProduceConfig | String | No | The video production configuration, in JSON format. For more information about the structure, see ProduceConfig. |
| UserData | UserData[] | No | The custom configurations, such as the callback configuration. The value is a JSON-formatted string. |
Note:
- Video resources used in the timeline of an online editing project can be materials from media assets or videos in the media library.
- Video production is performed based on the ProjectId and Timeline parameters. The specific logic is as follows:
- You must set at least either ProjectId or Timeline. If you do not set these parameters, video production fails.
- If you set only Timeline but not ProjectId, the system automatically creates an online editing project with the specified timeline. Then, the system obtains materials referenced in the timeline, sets them as materials of the online editing project, and starts video production.
- If you set only ProjectId but not Timeline, the system obtains the latest timeline based on the specified project ID to start video production.
- If you set both ProjectId and Timeline, the system starts video production based on the specified timeline and updates the timeline and materials for the online editing project. If you set other parameters, the system also updates these parameters for the online editing project.
- For more information about effect parameters, see Effect.
Response parameters
| Parameter | Type | Description |
|---|---|---|
| RequestId | String | The ID of the request. |
| MediaId | String | The ID of the produced video. |
Note:
- This operation returns the ID of the produced video, as indicated by the MediaId parameter.
- If this operation returns the MediaId parameter, the video production task is being asynchronously processed.
- Similar to video upload, ApsaraVideo for VOD sends a FileUploadComplete event notification after a video production task is completed. After the produced video is transcoded, ApsaraVideo for VOD sends the StreamTranscodeComplete and TranscodeComplete event notifications.
API examples
Sample request
http://vod.cn-shanghai.aliyuncs.com/?Action=ProduceEditingProjectVideo&ProjectId=fb2101bf24bf41c78b2754cb318787dc&Format=JSON&<Common request parameters>
Sample response
JSON format
{
"RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
"MediaId": "006204a11bb340d6b7f86bb25491f95f"
}
SDK examples
We recommend that you use a server SDK to call this operation. For more information about the sample code used to call this operation in various languages, see the following topics: