SubmitMediaProducingJob - 提交剪辑合成作业

将一个或多个素材片段合成为成品。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ProjectIdstring

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

xxxxxfb2101cb318xxxxx
Timelinestring

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

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

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

****96e8864746a0b6f3****
ClipsParamstring

模板对应的素材参数,Json格式,当TemplateId不为空时,ClipsParam不能为空。具体格式见 普通模板创建及使用高级模板创建及使用

见模板使用文档
ProjectMetadatastring

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

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

输出成品的目标类型。取值:

  • oss-object(客户在阿里云oss bucket下的oss object)

  • vod-media(阿里云vod的媒资)

oss-object
OutputMediaConfigstring

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

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

OutputMediaConfig 参数示例

{"MediaURL":"https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4"}
UserDatastring

自定义设置,Json格式,长度限制为512字节。支持自定义回调地址配置

{"NotifyAddress":"http://xx.xx.xxx"}或{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}
ClientTokenstring

保证请求幂等性。

****12e8864746a0a398****
Sourcestring

剪辑合成请求来源,取值范围:

  • OpenAPI:API 直接请求。

  • AliyunConsole:请求来自于阿里云控制台。

  • WebSDK:请求来自于集成了WebSDK的前端页面。

OPENAPI
EditingProduceConfigstring

剪辑合成参数, 参数详情

  • AutoRegisterInputVodMedia:是否需要将您时间线中的VOD媒资自动注册至IMS,默认为true。

  • OutputWebmTransparentChannel: 是否需要输出视频带透明通道,默认为false。

  • CoverConfig: 自定义封面图参数。

{ "AutoRegisterInputVodMedia": "true", "OutputWebmTransparentChannel": "true" }

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-*xxxxxx7d2a3811eb83da00163exxxxxx.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 结构中的参数说明

属性名类型描述
MediaURLString输出的媒资的 URL (当 OutputMediaTarget 的目标为 oss-object 时, 指定 OSS 文件的 HTTP URL 路径), 如:http://xxx-bucket-name.oss-cn-shanghai.aliyuncs.com/OSS 跟调用的服务所在区域相同。
StorageLocationString当 OutputMediaTarget 的目标为 vod-media 时, 指定 storage location 来存储媒资到 VOD;storage location 是 VOD 中的文件存储位置, 不包含 http:// 的前缀, 如:outin-xxxxxx.oss-cn-shanghai.aliyuncs.com。
FileNameString当 OutputMediaTarget 的目标为 vod-media 时,指定 fileName(包含文件后缀,不含路径)作为输出文件名。
WidthInteger输出成品的宽。可以不填,默认值是多个素材的最大宽。
HeightInteger输出成品的高。可以不填,默认值是多个素材的最大高。
BitrateInteger输出成品的码率,单位为Kbps。可以不填,默认值是多个素材的最高码率。
VodTemplateGroupIdString合成成片输出到vod,指定vod转码模板组。如不需要VOD转码,请填写 "VOD_NO_TRANSCODE"。

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

****36-3C1E-4417-BDB2-1E034F****
ProjectIdstring

剪辑工程ID。

****b4549d46c88681030f6e****
JobIdstring

合成作业ID。

****d80e4e4044975745c14b****
MediaIdstring

合成媒资ID。

****c469e944b5a856828dc2****
VodMediaIdstring

如果视频输出的位置为vod时,返回vod媒资id。

****d8s4h75ci975745c14b****

示例

正常返回示例

JSON格式

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

错误码

Http code错误码错误信息
400InvalidParameterThe specified parameter \ is not valid.
404ProjectNotFoundThe specified project not found

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2021-11-16OpenAPI 错误码发生变更、 OpenAPI 入参发生变更、 OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:EditingProduceConfig
出参OpenAPI 返回结构发生变更
阿里云首页 智能媒体生产 相关技术圈