本介面用於提交產生生動影像的任務。
介面說明
該介面為非同步介面,提交任務後返回任務 ID(此時任務尚未完成,任務將進入後台排隊非同步執行),最終結果將通過回調通知,也可通過查詢動圖任務詳細資料主動查詢任務狀態。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ice:SubmitDynamicImageJob |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Name |
string |
否 |
任務名稱 |
SampleJob |
| Input |
object |
是 |
任務輸入 |
|
| Type |
string |
是 |
輸入類型,取值:
枚舉值:
|
OSS |
| Media |
string |
是 |
輸入媒體。
OSS 地址規則為:
其中 bucket 為和當前專案處於同一地區的 OSS bucket 名稱,object 為檔案路徑。 說明
URL 中的 OSS bucket 需要先添加到 IMS儲存管理後再使用。 |
oss://bucket/object.mp4 |
| Output |
object |
是 |
任務輸出 |
|
| Type |
string |
是 |
輸出類型,取值:
枚舉值:
|
Media |
| Media |
string |
是 |
輸出媒體,支援 OSS 地址和媒資 ID 兩種。 OSS 地址規則為
其中 bucket 為和當前專案處於同一地區的 OSS bucket 名稱,object 為檔案路徑。 說明
URL 中的 OSS bucket 需要先添加到 IMS儲存管理後再使用。 |
****96e8864746a0b6f3**** |
| TemplateConfig |
object |
是 |
截圖模板配置 |
|
| TemplateId |
string |
是 |
模板 ID |
****96e8864746a0b6f3**** |
| OverwriteParams |
object |
否 |
覆蓋參數 |
|
| Format |
string |
否 |
動圖格式,取值:
枚舉值:
|
gif |
| Width |
integer |
否 |
輸出動圖寬度。取值範圍:[128, 4096]。 |
1024 |
| Height |
integer |
否 |
輸出動圖高度。取值範圍:[128, 4096]。 |
720 |
| Fps |
integer |
否 |
幀率。取值範圍:[1, 60]。 |
15 |
| ScanMode |
string |
否 |
掃描模式。可取值:
枚舉值:
|
progressive |
| LongShortMode |
boolean |
否 |
是否開啟橫豎屏自適應(長短邊模式)。取值:
預設值:true。 說明
轉碼輸出的寬對應輸入片源的長邊(豎屏為片源的高),高對應輸入視頻的短邊(豎屏為片源的寬)。 枚舉值:
|
false |
| TimeSpan |
object |
否 |
時間軸參數 |
|
| Seek |
string |
否 |
開始時間點。
|
01:59:59.999 或 32000.23 |
| Duration |
string |
否 |
持續時間長度。
|
01:59:59.999 或 32000.23 |
| End |
string |
否 |
截尾時間長度,表示切掉尾部的若干時間長度。設定此值時,參數 Duration 失效。
|
01:59:59.999 或 32000.23 |
| ScheduleConfig |
object |
否 |
調度配置 |
|
| PipelineId |
string |
否 |
管道 ID |
****96e8864746a0b6f3**** |
| Priority |
integer |
否 |
優先順序,1-10,預設 6。數值越大,優先順序越高。 |
6 |
| UserData |
string |
否 |
使用者自訂資訊 |
{"SampleKey": "SampleValue"} |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
PlainResponse |
||
| RequestId |
string |
請求 ID |
******11-DB8D-4A9A-875B-275798****** |
| JobId |
string |
任務 ID |
****20b48fb04483915d4f2cd8ac**** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"JobId": "****20b48fb04483915d4f2cd8ac****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。