全部产品

提交剪辑合成作业

调用SubmitMediaProducingJob将一个或多个素材片段合成为成品。可以通过设置模板Id或时间线参数直接提交剪辑合成作业,也可以先创建剪辑工程,再提交合成。

注意:该接口返回合成任务的提交结果,通常接口返回时成品处于合成中的状态。合成任务将进入后台排队,异步执行。提交后可以调用 查询剪辑合成作业(GetMediaProducingJob) 接口根据 jobId 来查询作业状态。 也可调用 获取媒资内容信息(GetMediaInfo)接口根据 MediaId 来查询生成媒资的信息。

请求参数

名称

类型

必填项

示例值

描述

Action

String

SubmitMediaProducingJob

OpenAPI 约定参数。取值:SubmitMediaProducingJob。

ProjectId

String

xxxxxfb2101cb318xxxxx

剪辑工程Id。注:ProjectId、Timeline、TemplateId有且只有一个非空。

Timeline

String

{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}

时间线,描述素材按照视频创意进行编排和特效设计的结果。Json格式。具体结构定义参见 Timeline配置说明。注:ProjectId、Timeline、TemplateId有且只有一个非空。

TemplateId

String

****96e8864746a0b6f3****

模板Id,用于快速低门槛的构建时间线。注:ProjectId、Timeline、TemplateId有且只有一个非空。当TemplateId不为空时,ClipsParam不能为空。

ClipsParam

String

{"VideoArray":["****05512043f49f697f7425****","****05512043f49f697f7425****","****05512043f49f697f7425****"]}

模板对应的素材参数,Json格式。具体结构定义参见 模板工厂。当TemplateId不为空时,ClipsParam不能为空。

ProjectMetadata

String

{"Description":"剪辑视频描述","Title":"剪辑标题测试"}

剪辑工程的元数据信息,Json格式。具体结构定义参见CommonMetadata

OutputMediaTarget

String

oss-object

输出成品的目标类型。取值:oss-object(客户在阿里云oss bucket下的oss object)vod-media(阿里云vod的媒资)live-stream(阿里云直播中心的直播流)

OutputMediaConfig

String

{"MediaURL":"https://testice-testbucket.oss-cn-shanghai.aliyuncs.com/test/xxxxxtest001xxxxx.mp4"}

输出成品的目标配置,Json格式。可以设置输出成品的在OSS 上的URL,或者VOD Bucket 中的存储位置。

输出到OSS时,输出目标的 MediaURL 必填;输出到VOD 时,StorageLocation 和 FileName 两个参数必填。

其他参数参考下文 OutputMediaConfig 参数示例。

UserData

String

自定义设置,Json格式,长度限制为512字节。

ClientToken

String

****12e8864746a0a398****

保证请求幂等性。

OutputMediaConfig 参数示例

示例: 输出到 oss

{
"MediaURL":"https://my-test-bucket.oss-cn-shanghai.aliyuncs.com/test/xxxxxtest001xxxxx.mp4",
"Bitrate": 2000,  
"Width": 800,  
"Height": 680
}

当输出到 OSS 时,MediaURL 必填。OutputMediaTarget 参数默认值为 "oss-object", 表示输出到 OSS。 其他参数可以选填,其中 Bitrate 用来设置输出成品的码率,通常码率越高越清晰,最大可以设置到 5000。 Width, Height 用来设置成品的分辨率。

OSS URL 的路径格式: https://bucketname.oss-region-name.aliyuncs.com/xxx/yyy.ext

bucketname 是 OSS Bucket 的名称。

oss-region-name.aliyuncs.com 是 OSS 文件的外网 Endpoint,比如上海,北京,杭州的分别是:

oss-cn-shanghai.aliyuncs.com
oss-cn-hangzhou.aliyuncs.com 
oss-cn-beijing.aliyuncs.com

示例: 输出到 vod

{ 
"StorageLocation": "outin-8e7b1c7d2a3811eb83da00163e00b174.oss-cn-shanghai.aliyuncs.com",  
"FileName": "output.mp4",  
"Bitrate": 2000,  
"Width": 800,  
"Height": 680
}

当输出到 VOD 时, StorageLocation 和 FileName 两个参数必填。OutputMediaTarget 参数设置为 "vod-media", 表示输出到点播 VOD 的存储Bucket。点播VOD可以使用的存储位置可以在 VOD 里面上传媒资后,在媒资的存储地址中看到。

OutputMediaConfig 结构中的参数说明

属性名

类型

描述

MediaURL

String

输出的媒资的 URL (当 OutputMediaTarget 的目标为 oss-object 时, 指定 OSS 文件的 HTTP URL 路径), 如:

http://xxx-bucket-name.oss-cn-shanghai.aliyuncs.com/

OSS 跟调用的服务所在区域相同

StorageLocation

String

当 OutputMediaTarget 的目标为 vod-media 时, 指定 storage location 来存储媒资到 VOD; storage location 是 VOD 中的文件存储位置, 不包含 http:// 的前缀, 如:

outin-xxxxxx.oss-cn-shanghai.aliyuncs.com

FileName

String

当 OutputMediaTarget 的目标为 vod-media 时,指定 fileName(包含文件后缀,不含路径)作为输出文件名

Width

Integer

输出成品的宽。可以不填,默认值是多个素材的最大宽:

Height

Integer

输出成品的高。可以不填,默认值是多个素材的最大高:

Bitrate

Integer

输出成品的码率,单位为Kbps。可以不填,默认值是多个素材的最高码率:

ProduceTemplateId

String

定制参数,合成模板Id,与MPS转码模板Id一致,用于设置输出成品的合成转码参数。用于特殊场景下定制视频处理,模板 ID 为 MPS 系统中的转码模板ID,可以在 MPS 产品中创建。

返回参数

名称

类型

描述

RequestId

String

请求Id

ProjectId

String

剪辑工程Id

MediaId

String

输出成品的MediaId

JobId

String

合成作业Id

请求示例

https://ice.cn-shanghai.aliyuncs.com/?Action=SubmitMediaProducingJob
&<公共请求参数>

正常返回示例

JSON 格式

{
    "RequestId": "****36-3C1E-4417-BDB2-1E034F****",
    "MediaId": "****c469e944b5a856828dc2****",
    "ProjectId":"****b4549d46c88681030f6e****",
    "JobId":"****d80e4e4044975745c14b****"
}

XML 格式

<SubmitMediaProducingJobResponse>
      <RequestId>****36-3C1E-4417-BDB2-1E034F****</RequestId>
      <MediaId>****c469e944b5a856828dc2****</MediaId>
      <ProjectId>****b4549d46c88681030f6e****</ProjectId>
    <JobId>****d80e4e4044975745c14b****</JobId>
</SubmitMediaProducingJobResponse>