将一个或多个直播流区间合成为成品。提交直播剪辑任务后,任务将进入后台排队,异步执行。提交后可以调用查询直播剪辑作业(GeLiveEditingJob )接口根据 jobId 来查询作业状态。 也可调用获取媒资内容信息(GetMediaInfo)接口根据 MediaId 来查询生成媒资的信息。
接口说明
当前支持对录制到OSS 和 vod 的直播流进行直播剪辑。多直播流混剪时,仅支持直播流都录制到OSS 或直播流都录制到vod。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Clips | string | 是 | 剪辑片段列表,输出的成片由列表中的片段按顺序收尾拼接而成,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\" }] |
ProjectId | string | 否 | 直播剪辑工程ID。若非空,读取project相关存储配置。 若为空,则以入参存储配置为准。 | ****fddd7748b58bf1d47e95**** |
LiveStreamConfig | string | 否 | 直播流配置, JSON Object AppName: 播流所属应用名称 DomainName: 域名 StreamName: 直播流名 | { "AppName": "app", "DomainName": "domain.com", "StreamName": "stream" } |
OutputMediaConfig | string | 否 | 输出成品的目标配置,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" } |
MediaProduceConfig | string | 否 | 生成片段的合成配置,用JSON格式表示。其中,Mode为剪辑模式,取值:
| { "Mode": "AccurateFast"} |
UserData | string | 否 | 自定义设置,JSON Object,长度限制为512字节。 | {"key": "value"} |
OutputMediaTarget | string | 否 | 输出成品的目标类型。取值:
| oss-object 或 vod-media |
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 | 自定义截图输出地址, OSS bucket 需与服务接入区域保持一致。仅支持自有OSS bucket,不支持VOD 托管bucket。 | 否 |
返回参数
示例
正常返回示例
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****"
}
错误码
访问错误中心查看更多错误码。