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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String SubmitLiveEditingJob

系统规定参数。取值:SubmitLiveEditingJob

Clips String [{\"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\" }]

剪辑片段列表,输出的成片由列表中的片段按顺序收尾拼接而成。JSON 数组格式。每一个片段都包含开始时间和结束时间。如果没有直播流参数,则以外层的直播流配置为准。开始和结束时间戳皆为UTC时间。参数详情请见下方 Clip 数据结构。

ProjectId String ****fddd7748b58bf1d47e95****

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

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

直播流配置 AppName: 播流所属应用名称 DomainName: 域名 StreamName: 直播流名

OutputMediaConfig String { "MediaURL": "https://ice-auto-test.oss-cn-shanghai.aliyuncs.com/testfile.mp4" }, 或 { "StorageLocation": "bucket.oss-cn-shanghai.aliyuncs.com", "FileName": "output.mp4" }

输出成品的目标配置,Json格式。可以设置输出成品的在OSS 上的URL,或者VOD Bucket 中的存储位置。 输出到OSS时,输出目标的 MediaURL 必填;输出到VOD 时,StorageLocation 和 FileName 两个参数必填。

MediaProduceConfig String { "Mode": "AccurateFast"}

生成片段的合成配置,json string

"Mode": 剪辑模式,默认模式 "AccurateFast" 快速精剪

- "Accurate": 精确剪辑,可指定输出成片宽高。

- "AccurateFast": 快速精剪,相较于Accurate模式合成速度更快。输出文件与源流分辨率一致,不支持指定输出成片宽高。

- "Rough": 粗略剪辑,最小精度为一个ts分片时长,可指定输出成片宽高。

- "RoughFast": 快速粗剪,相较于Accurate模式合成速度更快,最小精度为一个ts分片时长。输出文件与源流分辨率一致,不支持指定输出成片宽高。

UserData String {"key": "value"}

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

OutputMediaTarget String oss-object 或 vod-media

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

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

Clip 数据结构

属性名

类型

示例值

描述

是否必填

StartTime

String

2021-06-21T08:01:00Z

截取片段的开始时间,格式为UTC时间戳

EndTime

String

2021-06-21T08:05:00Z

截取片段的结束时间,格式为UTC时间戳

AppName

String

app

播流所属应用名,如果为空,以外层直播流配置为准

DomainName

String

domain.com

域名 ,如果为空,以外层直播流配置为准

StreamName

String

stream

直播流名,如果为空,以外层直播流配置为准

CoverTime

String

2021-06-21T08:03:00Z

指定片段中的某一时间戳,作为成片的封面图,格式为UTC时间戳 。当多个clip 都设置CoverTime参数时,仅第一个生效,CoverTime 必须大于等于StartTime,小于等于Endtime。

CoverUrl

String

http://test-oss.cn-shanghai.aliyuncs.com

自定义截图输出地址, oss bucket 需与服务接入区域保持一致。仅支持自有oss bucket,不支持vod 托管bucket。

返回数据

名称 类型 示例值 描述
RequestId String ****36-3C1E-4417-BDB2-1E034F****

请求ID

ProjectId String ****fddd7748b58bf1d47e95****

直播剪辑工程ID

JobId String ****d80e4e4044975745c14b****

直播剪辑任务ID

MediaId String ****c469e944b5a856828dc2****

合成成片媒资ID

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

合成成片地址

示例

请求示例

http(s)://ice.cn-shanghai.aliyuncs.com/?Action=SubmitLiveEditingJob
&Clips=[{\"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\" }]
&ProjectId=****fddd7748b58bf1d47e95****
&LiveStreamConfig={"AppName":"app", DomainName": "domain.com", "StreamName": "stream"  }
&OutputMediaConfig={ "MediaURL": "https://ice-auto-test.oss-cn-shanghai.aliyuncs.com/testfile.mp4"}
&MediaProduceConfig={ "Mode": "AccurateFast"}
&UserData={"key": "value"}
&OutputMediaTarget=oss-object
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SubmitLiveEditingJobResponse>
    <RequestId>****36-3C1E-4417-BDB2-1E034F****</RequestId>
    <ProjectId>****fddd7748b58bf1d47e95****</ProjectId>
    <JobId>****d80e4e4044975745c14b****</JobId>
    <MediaId>****c469e944b5a856828dc2****</MediaId>
    <MediaURL>http://test-bucket.cn-shanghai.aliyuncs.com/test.mp4</MediaURL>
</SubmitLiveEditingJobResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

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