文档

SubmitLiveEditingJob - 提交直播剪辑任务

更新时间:

直播剪辑指将一个或多个直播流区间合成为成品。提交直播剪辑任务后,任务将进入后台排队,异步执行。提交后可以调用查询直播剪辑作业(GeLiveEditingJob )接口根据 jobId 来查询作业状态。 也可调用获取媒资内容信息(GetMediaInfo)接口根据 MediaId 来查询生成媒资的信息。

接口说明

当前支持对录制到 OSS 和 VOD 的直播流进行直播剪辑。多直播流混剪时,仅支持直播流都录制到 OSS 或直播流都录制到 VOD。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:SubmitLiveEditingJob
  • 全部资源
    *

请求参数

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

剪辑片段列表,输出的成片由列表中的片段按顺序收尾拼接而成,JSON Array。

每一个片段都包含开始时间和结束时间。如果没有直播流参数,则以外层的直播流配置为准。开始和结束时间戳皆为 UTC 时间。参数详情请见下方 Clip 数据结构。

[{\"StartTime\": \" 2021-06-21T08:01:00Z\", \"EndTime\": \" 2021-06-21T08:03:00Z\" , "AppName": "app", "DomainName": "domain.com", "StreamName": "stream"}, {\"StartTime\": \" 2021-06-21T08:05:00Z\", \"EndTime\": \" 2021-06-21T08:09:00Z\" }]
ProjectIdstring

直播剪辑工程 ID。若非空,读取 project 相关存储配置。 若为空,则以入参存储配置为准。

****fddd7748b58bf1d47e95****
LiveStreamConfigstring

直播流配置, JSON Object。需包含如下配置项:

  • AppName:播流所属应用名称

  • DomainName:域名

  • StreamName:直播流名

{ "AppName": "app", "DomainName": "domain.com", "StreamName": "stream" }
OutputMediaConfigstring

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

  • 输出到 OSS 时,输出目标的 MediaURL 必填。
  • 输出到 VOD 时,StorageLocation 和 FileName 两个参数必填。
{ "MediaURL": "https://ice-auto-test.oss-cn-shanghai.aliyuncs.com/testfile.mp4" }, 或 { "StorageLocation": "bucket.oss-cn-shanghai.aliyuncs.com", "FileName": "output.mp4" }
MediaProduceConfigstring

生成片段的合成配置,用 JSON 格式表示。其中,Mode 为剪辑模式,取值:

  • AccurateFast(默认值):快速精剪,相较于 Accurate 模式合成速度更快。输出文件与源流分辨率一致,不支持指定输出成片宽高。
  • Accurate:精确剪辑,可指定输出成片宽高。
  • Rough:粗略剪辑,最小精度为一个 TS 分片,成片包含用户指定起止时间内所有分片,可指定输出成片宽高。
  • RoughFast:快速粗剪,相较于 Accurate 模式合成速度更快,最小精度为一个 TS 分片,成片包含用户指定起止时间内所有分片。输出文件与源流分辨率一致,不支持指定输出成片宽高。
{ "Mode": "AccurateFast"}
UserDatastring

自定义设置,JSON Object,长度限制为 512 字节。

{"key": "value"}
OutputMediaTargetstring

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

  • oss-object 阿里云 oss bucket 下的 oss object
  • vod-media 阿里云 vod 的媒资
oss-object

Clip 数据结构

属性名类型示例值描述是否必填
StartTimeString2021-06-21T08:01:00Z截取片段的开始时间,格式为 UTC 时间戳
EndTimeString2021-06-21T08:05:00Z截取片段的结束时间,格式为 UTC 时间戳
AppNameStringapp播流所属应用名,如果为空,以外层直播流配置为准
DomainNameStringdomain.com域名 ,如果为空,以外层直播流配置为准
StreamNameStringstream直播流名,如果为空,以外层直播流配置为准
CoverTimeString2021-06-21T08:03:00Z指定片段中的某一时间戳,作为成片的封面图,格式为 UTC 时间戳 。当多个 clip 都设置 CoverTime 参数时,仅第一个生效,CoverTime 必须大于等于 StartTime,小于等于 Endtime。
CoverUrlStringhttps://test.oss-cn-shanghai.aliyuncs.com自定义截图输出地址, OSS bucket 需与服务接入区域保持一致。仅支持自有 OSS bucket,不支持 VOD 托管 bucket。

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

直播剪辑工程 ID。

****fddd7748b58bf1d47e95****
JobIdstring

直播剪辑任务 ID。

****d80e4e4044975745c14b****
MediaIdstring

合成成片媒资 ID。

****c469e944b5a856828dc2****
MediaURLstring

合成成片地址。

http://test-bucket.cn-shanghai.aliyuncs.com/test.mp4
VodMediaIdstring

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

****d7578s4h75ci945c14b****

示例

正常返回示例

JSON格式

{
  "RequestId": "****36-3C1E-4417-BDB2-1E034F****",
  "ProjectId": "****fddd7748b58bf1d47e95****",
  "JobId": "****d80e4e4044975745c14b****",
  "MediaId": "****c469e944b5a856828dc2****",
  "MediaURL": "http://test-bucket.cn-shanghai.aliyuncs.com/test.mp4",
  "VodMediaId": "****d7578s4h75ci945c14b****"
}

错误码

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