直播剪輯指將一個或多個直播流區間合成為成品。提交直播剪輯任務後,任務將進入後台排隊,非同步執行。提交後可以調用查詢直播剪輯作業(GeLiveEditingJob )介面根據 jobId 來查詢作業狀態。 也可調用擷取媒資內容資訊(GetMediaInfo)介面根據 MediaId 來查詢產生媒資的資訊。
介面說明
當前支援對錄製到 OSS 和 VOD 的直播流進行直播剪輯。多直播流混剪時,僅支援直播流都錄製到 OSS 或直播流都錄製到 VOD。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ice:SubmitLiveEditingJob |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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": "app", "DomainName": "domain.com", "StreamName": "stream" } |
| OutputMediaConfig |
string |
否 |
輸出成品的目標配置,JSON Object。可以設定輸出成品的在 OSS 上的 URL,或者 VOD Bucket 中的儲存位置。
|
{ "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 |
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 | https://test.oss-cn-shanghai.aliyuncs.com | 自訂截圖輸出地址, OSS bucket 需與服務接入地區保持一致。僅支援自有 OSS bucket,不支援 VOD 託管 bucket。 | 否 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
請求 ID。 |
****36-3C1E-4417-BDB2-1E034F**** |
| ProjectId |
string |
直播剪輯工程 ID。 |
****fddd7748b58bf1d47e95**** |
| JobId |
string |
直播剪輯任務 ID。 |
****d80e4e4044975745c14b**** |
| MediaId |
string |
合成成片媒資 ID。 |
****c469e944b5a856828dc2**** |
| MediaURL |
string |
合成成片地址。 |
http://test-bucket.cn-shanghai.aliyuncs.com/test.mp4 |
| VodMediaId |
string |
如果視頻輸出的位置為 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****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。