调用ProduceEditingProjectVideo将一个或多个视频合成为成品。可以通过时间线参数直接提交源视频,也可以先创建云剪辑工程,再提交合成。
使用说明
- 建议您将视频点播的剪辑服务升级为独立产品智能媒体生产(Intelligent Cloud Editing,简称ICE),详细说明,请参见升级说明。
- 该接口返回合成任务的提交结果,不保证接口返回时视频已合成完毕。合成任务将进入后台排队,异步执行。
- 云剪辑时间线所使用的视频资源,既可以是素材管理中的素材,也可以是媒体库中的视频。
- 合成视频依据ProjectId与Timeline进行,具体逻辑如下:
- ProjectId与Timeline不能同时为空,否则合成视频没有任何依据。
- 如果ProjectId为空,Timeline不为空,则自动创建一个云剪辑工程,以Timeline为时间线,同时提取Timeline中引用的素材并设置为云剪辑工程的素材,之后进行视频合成。
- 如果ProjectId不为空,Timeline为空,则根据ProjectId获取最新保存的Timeline,并以此进行视频合成。
- 如果ProjectId与Timeline均不为空,则以传入的Timeline为准,进行视频合成,同时更新对应的云剪辑工程(Timeline和云剪辑工程素材)。如果填写其他字段,则对相应的云剪辑工程字段进行更新。
- 您还可以为合成视频添加特效。更多详情,请参见特效。
QPS限制
本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ProduceEditingProjectVideo |
系统规定参数。取值:ProduceEditingProjectVideo。 |
| ProjectId | String | 否 | fb2101bf24b4cb318787dc**** |
云剪辑工程ID。可通过以下方式获取: |
| Timeline | String | 否 | {"VideoTracks":[{"VideoTrackClips":[{"MediaId":"cc3308ac59615a54328bc3443****"},{"MediaId":"da87a9cff645cd88bc6d8326e4****"}]}]} |
云剪辑工程时间线,JSON格式。具体结构定义,请参见Timeline。 |
| Title | String | 否 | 剪辑合成测试 |
云剪辑工程标题。 |
| Description | String | 否 | 描述 |
云剪辑工程描述。 |
| CoverURL | String | 否 | https://example.aliyundoc.com/6AB4D0E1E1C7446888351****.png |
云剪辑工程封面。 |
| MediaMetadata | String | 否 | {"Description":"合成视频描述","Title":"合成userData测试"} |
合成视频的元数据,JSON格式。具体结构定义,请参见MediaMetadata。 |
| ProduceConfig | String | 否 | {"TemplateGroupId":"6d11e25ea30a4c465435c74****"} |
合成配置,JSON格式。具体结构定义,请参见ProduceConfig。 说明 当地域为除上海以外的其他地域时,StorageLocation字段必填。
|
| UserData | String | 否 | {"Extend":{"width":1280,"id":"028a8e56b1ebf6bb7afc74****","height":720},"MessageCallback":{"CallbackURL":"https://example.aliyundoc.com/2016-08-15/proxy/httpcallback/testcallback/","CallbackType":"http"}} |
自定义设置,为JSON字符串,支持消息回调等设置。具体结构定义,请参见UserData。 说明 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用,否则回调设置不生效。
|
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 25818875-5F78-4AF6-D7393642CA58**** |
请求ID。 |
| MediaId | String | 006204a11bb386bb25491f95f**** |
合成的视频ID。 说明
|
| ProjectId | String | fb2101bf24b4cb318787dc**** |
云剪辑工程ID。 |
示例
请求示例
http(s)://vod.cn-shanghai.aliyuncs.com/?Action=ProduceEditingProjectVideo
&ProjectId=fb2101bf24b4cb318787dc****
&Timeline={"VideoTracks":[{"VideoTrackClips":[{"MediaId":"cc3308ac59615a54328bc3443****"},{"MediaId":"da87a9cff645cd88bc6d8326e4****"}]}]}
&Title=剪辑合成测试
&Description=描述
&CoverURL=https://example.aliyundoc.com/6AB4D0E1E1C7446888351****.png
&MediaMetadata={"Description":"合成视频描述","Title":"合成userData测试"}
&ProduceConfig={"TemplateGroupId":"6d11e25ea30a4c465435c74****"}
&UserData={"Extend":{"width":1280,"id":"028a8e56b1ebf6bb7afc74****","height":720},"MessageCallback":{"CallbackURL":"https://example.aliyundoc.com/2016-08-15/proxy/httpcallback/testcallback/","CallbackType":"http"}}
&<公共请求参数>
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ProduceEditingProjectVideoResponse>
<RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>
<MediaId>006204a11bb386bb25491f95f****</MediaId>
<ProjectId>fb2101bf24b4cb318787dc****</ProjectId>
</ProduceEditingProjectVideoResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "25818875-5F78-4AF6-D7393642CA58****",
"MediaId" : "006204a11bb386bb25491f95f****",
"ProjectId" : "fb2101bf24b4cb318787dc****"
}
错误码
访问错误中心查看更多错误码。
SDK示例
建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见: