SubmitMediaProducingJob
SubmitMediaProducingJob接口主要用于提交一个媒体剪辑合成任务。当用户需要对视频或音频素材进行剪辑、合成或其他形式的后期制作时,可以通过调用此API接口来实现自动化处理
服务地址:
华东1(杭州)
输入参数
只看必填
ProjectId剪辑工程ld
Timeline云剪辑任务时间线
TemplateId模板Id
ClipsParam模板对应的素材参数
ProjectMetadata剪辑工程的元数据信息
OutputMediaTarget输出成品的目标类型
OutputMediaConfig输出成品的目标配置
UserData自定义设置
ClientToken保证请求幂等性
Source剪辑合成请求来源
EditingProduceConfig剪辑合成参数
MediaMetadata合成视频的元数据
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 计费说明:视频剪辑按照剪辑合成的成片时长计费,详情请参见视频剪辑。若处理失败,不收取费用。

  • 多样化剪辑能力:当您需要将素材按照个性化创意进行编排和设计时,您需要调用该接口,该接口支持通过灵活的 Timeline 配置,实现复杂的视频剪辑需求。

  • 素材引用规则:云剪辑时间线中引用的素材,既可以是素材库中的媒资,也可以直接引用 OSS 文件,暂不支持外部地址或 CDN 地址。当素材为 OSS 文件时,MediaUrl 仅支持 OSS 地址格式,如:https://your-bucket.oss-region-name.aliyuncs.com/your-object.ext。

  • 异步执行任务:该接口返回合成任务的提交结果,不保证接口返回时视频已合成完毕。合成任务将进入后台排队,异步执行。

  • 任务状态查询:调用 GetMediaProducingJob ,通过传入 JobId 查询任务状态和结果。

  • 媒资注册与分析:视频合成完成后,会自动注册媒资,此时媒资还是分析中状态,当媒资分析完成后,可以根据 MediaId 获取成片时长及分辨率信息。

使用限制

  • 该接口的流量控制值为 30 QPS。
    说明 如果超出此限制,可能会遇到 "Throttling.User" 错误。详情请参见: 提交剪辑任务时遇到“Throttling.User”错误
  • 视频轨、图片轨、字幕轨的轨道数每种均限制最多 100 个。
  • 素材个数无限制,素材文件总大小不能超过 1 TB。
  • 输入或输出 OSS Bucket 所在 Region,必须和使用 IMS 的 Region 保持一致。
  • 当输出为视频时,成片分辨率有以下限制:
    • 宽高都不能小于 128 px。
    • 宽高都不能大于 4096 px。
    • 短边不能大于 2160 px。

请求参数

字段名称字段详情
ProjectIdstring

剪辑工程 ld。你可调用 CreateEditingProject 接口创建剪辑工程,并获取 ProjectId 提交剪辑任务。展开详情

示例值:xxxxxfb2101cb318xxxxx参考取值来源:
    ListEditingProjects
    SearchEditingProject
    CreateEditingProject
    GetProjectExportJob
    AddEditingProjectMaterials
Timelinestring

云剪辑任务时间线,当您需要将素材按照视频创意进行编排和特效设计时,可以手动构建 Timeline 参数。展开详情

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

模板 Id,用于快速低门槛的构建时间线。可调用 GetTemplate 获取模板信息。展开详情

示例值:****96e8864746a0b6f3****参考取值来源:
    AddTemplate
    GetTemplate
    ListTemplates
    CreateCustomTemplate
ClipsParamstring

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

示例值:见模板使用文档
ProjectMetadatastring

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

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

输出成品的目标类型。取值:展开详情

示例值:oss-object
OutputMediaConfigstring

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

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

自定义设置,Json 格式,长度限制为 512 字节。支持自定义回调地址配置。其中:展开详情

示例值:{"NotifyAddress":"https://xx.com/xx","RegisterMediaNotifyAddress":"https://xxx.com/xx"}
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。

示例值:****12e8864746a0a398****
Sourcestring

剪辑合成请求来源,取值范围:展开详情

示例值:OPENAPI参考取值来源:
    ListSources
    CreateSource
    UpdateSource
EditingProduceConfigstring

剪辑合成参数,配置详情请参见 EditingProduceConfig 参数详情展开详情

示例值:{ "AutoRegisterInputVodMedia": "true", "OutputWebmTransparentChannel": "true" }
MediaMetadatastring

合成视频的元数据,JSON 格式。具体结构定义,请参见 MediaMetadata

示例值:{ "Title":"test-title", "Tags":"test-tags1,tags2" }

请求说明

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。可以不填,默认值是多个素材的最高码率,上限为 5000。若还要保留最高素材的码率,需要设置 EditingProduceConfig.KeepOriginMaxBitrate=true,详情请参见 EditingProduceConfig
VodTemplateGroupIdString合成成片输出到 vod,指定 vod 转码模板组。如不需要 VOD 转码,请填写 "VOD_NO_TRANSCODE"。

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:****36-3C1E-4417-BDB2-1E034F****
ProjectIdstring

剪辑工程 ID。

示例值:****b4549d46c88681030f6e****
JobIdstring

合成作业 ID。

示例值:****d80e4e4044975745c14b****
MediaIdstring

合成媒资 ID。

示例值:****c469e944b5a856828dc2****
VodMediaIdstring

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

示例值:****d8s4h75ci975745c14b****
变更历史
变更时间变更内容概要操作
2023-11-23
变更请求参数Timeline
2023-04-25
新增请求参数MediaMetadata
2022-09-16
变更请求参数OutputMediaConfig
2021-11-16
新增请求参数EditingProduceConfig
变更返回参数
2021-06-03
变更返回参数