本文旨在介紹如何使用SubmitSegmentationJob - 提交拆條任務進行智能拆條,以及介紹通過GetSmartHandleJob - 擷取智慧工作提示結果擷取智能拆條任務結果的返回參數。計費相關說明詳見智能拆條計費說明。
注意:在此介面中,所有媒資的OSS URL中的地區(region)必須與調用OpenAPI服務地址中的地區(region)保持一致。
支援的地區:華東2(上海)、華北2(北京)、華東1(杭州)、華南1(深圳)、美國(西部)、新加坡。
使用說明
智能拆條的OpenAPI請參閱SubmitSegmentationJob - 提交拆條任務,關鍵參數詳見下文中JobParams 參數說明、InputConfig 參數說明、OutputConfig 參數說明。
查詢智能拆條任務的結果,請調用GetSmartHandleJob - 擷取智慧工作提示結果擷取,任務返回結果中的關鍵參數詳見AiResult 參數說明。
JobParams 參數說明
使用者可通過配置JobParams,指定視頻分鏡拆條的策略。
參數 | 類型 | 說明 | 是否必填 |
Mode | String | 拆條模式,取值範圍:
| 是 |
Ranges | List<Range> | 用於設定自訂拆條的時間區間,Mode為UserDefined時必填。 | 否 |
Range 參數說明
參數 | 類型 | 說明 | 是否必填 |
In | Float | 拆條片段開始時間,單位秒。例如:0。 | 是 |
Out | Float | 拆條片段結束時間,單位秒。例如:10。 | 是 |
參數樣本
{
"Mode": "UserDefined",
"Ranges": [
{
"In": 0,
"Out": 10
},
{
"In": 20,
"Out": 30
}
]
}InputConfig 參數說明
使用者可通過配置InputConfig,指定視頻素材。
參數 | 類型 | 說明 | 是否必填 |
Type | String | 媒體類型,以下類型二選一:
| 是 |
Media | String |
| 是 |
參數樣本
{
"Type": "Media",
"Media": "c5c62d8f0*********12dce8e77dc6d"
}OutputConfig 參數說明
使用者可通過配置OutputConfig,指定輸出地址、名稱規則等合成參數。
參數 | 類型 | 說明 | 必填 | 樣本 |
OutputMediaTarget | String | 輸出檔案的目標類型。
| 是 | oss-object |
Endpoint | String | 滿足S3協議的Endpoint。
預設為同一Region的OSS endpoint。 | 否 | https://oss-cn-shanghai.aliyuncs.com |
Bucket | String | 滿足S3協議的儲存Bucket。
| 是 | test-output |
ObjectKey | String | 滿足S3協議的對象名。 支援的預留位置:
| 是 | dir/to/testOutput_{index}.mp4 |
ExportAsNewMedia | Boolean | 是否輸出為新媒資。 僅當OutputMediaTarget = oss-object時支援填寫。 | 否,預設false | false |
Width | Integer | 成片寬,單位:px。不填則和素材視頻相同。 | 否 | 1280 |
Height | Integer | 成片高,單位:px。不填則和素材視頻相同。 | 否 | 720 |
JSONObject | 輸出視頻流相關配置,Crf、Codec等。 | 否 | { "Bitrate": 3000 } |
參數樣本
{
"OutputMediaTarget": "oss-object",
"Endpoint": "https://oss-cn-shanghai.aliyuncs.com"
"Bucket": "test-output",
"ObjectKey": "dir/to/testOutput_{index}.mp4",
"ExportAsNewMedia": false,
"Width": 1280,
"Height": 720,
"Video": {
"Bitrate": 3000
}
}GetSmartHandleJob 返回參數說明
通過GetSmartHandleJob - 擷取智慧工作提示結果擷取智能拆條任務的結果,AiResult的參數說明如下:
AiResult 參數說明
{
"SegmentationResult": {
"OutputEndpoint": "http://oss-cn-shanghai.aliyuncs.com", // 滿足S3協議的Endpoint
"OutputBucket": "test-output", // 滿足S3協議的Bucket
"OutputObjectResults": [ // 分鏡拆條後的結果
{
"ObjectKey": "testOutput_0.mp4", // 滿足S3協議的對象名
"MediaId": "xxx1" // 分鏡拆條後產生的媒資Id
},
{
"ObjectKey": "testOutput_0.mp4",
"MediaId": "xxx2"
}
]
}
}