建立一個非同步媒體轉碼任務。提供媒體轉碼、媒體拼接、視頻截幀、視頻轉動圖等相關音視頻媒體檔案處理能力。
介面說明
請確保在使用該介面前,已充分瞭解Intelligent Media Management產品的收費方式和價格。
- 調用該介面前,請確保當前 Region 已經存在可用的專案(Project),詳見專案管理。
重要 非同步任務不保證時效。
使用該介面進行媒體轉碼時,預設只處理一路視頻/音頻/字幕流,同時支援配置處理的視頻/音頻/字幕流數量。
使用該介面進行媒體拼接時,最大支援的媒體數量為 11 個,此時配置的轉碼、截幀等參數將作用於拼接後媒體資料。
該介面為非同步介面,擷取任務開始執行後,任務資訊只儲存 7 天,超過 7 天則無法再擷取。調用 GetTask 或 ListTasks 介面擷取返回的
TaskId,查看任務資訊。也可以通過設定 Notification 訊息通知參數,通過訊息通知擷取任務資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
imm:CreateMediaConvertTask |
create |
*Project
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ProjectName |
string |
是 |
專案名稱,擷取方式請參見建立專案。 |
test-project |
| Sources |
array<object> |
是 |
媒體檔案列表。若列表元素大於 1 個則表示開啟 Concat(拼接)功能,Concat 順序為輸入視頻檔案 URI 的順序。 |
|
|
array<object> |
否 |
源媒體檔案。 |
||
| URI |
string |
否 |
OSS 地址規則為 |
oss://test-bucket/test-object |
| StartTime |
number |
否 |
媒體轉碼開始時間,單位為秒。取值範圍如下:
|
0 |
| Duration |
number |
否 |
媒體轉碼時間長度。單位為秒,預設值為 0,表示到視頻結束時間。 |
0 |
| Subtitles |
array<object> |
否 |
添加字幕列表,預設為空白。 |
|
|
object |
否 |
字幕資訊。 |
||
| URI |
string |
否 |
OSS 地址規則為 |
oss://test-bucket/test-object |
| TimeOffset |
number |
否 |
字幕延遲時間,單位為秒,預設為 0。 |
10.5 |
| Language |
string |
否 |
字幕語言,參考標準為 ISO 639-2,預設為空白。 |
eng |
| Attached |
boolean |
否 |
將當前源媒體檔案作為同步播放的音頻流或視頻流添加到輸出媒體檔案中,預設值為 false。 說明
|
false |
| AlignMode |
string |
否 |
添加音視頻流的對齊策略,取值範圍如下:
說明
|
false |
| DisableVideo |
boolean |
否 |
是否禁用該源媒體檔案中的視頻,取值範圍如下:
|
false |
| DisableAudio |
boolean |
否 |
是否禁用該源媒體檔案中的音頻,取值範圍如下:
|
false |
| Targets |
array<object> |
是 |
ApsaraVideo for Media Processing工作清單,支援配置多任務。 |
|
|
array<object> |
否 |
Targets 數組元素的詳細資料。 |
||
| URI |
string |
否 |
媒體轉碼輸出檔案的 OSS 地址。 OSS 地址規則為
|
oss://test-bucket/test-target-object.mp4 |
| Container |
string |
否 |
媒體容器類型。可選容器類型如下:
|
mp4 |
| Speed |
number |
否 |
媒體倍速播放設定,取值範圍為[0.5,1.0],預設為 1.0。 說明
轉碼後媒體檔案與源媒體檔案預設播放速度的比值,非倍速轉碼。 |
1.0 |
| Segment |
object |
否 |
媒體切片設定,預設不進行切片。 |
|
| Format |
string |
否 |
媒體切片方式。取值範圍如下:
|
hls |
| Duration |
number |
否 |
切片長度。單位為秒。 |
30 |
| StartNumber |
integer |
否 |
起始序號,僅支援 hls,預設為 0。 |
5 |
| Video | TargetVideo |
否 |
視頻處理參數配置。 重要 當 Video 為空白值時,會將第一路視頻流(若存在)直接拷貝到輸出檔案。 |
|
| Audio | TargetAudio |
否 |
音頻處理參數配置。 重要 當 Audio 為空白值時,會將第一路音頻流(若存在)直接拷貝到輸出檔案。 |
|
| Subtitle | TargetSubtitle |
否 |
字幕處理參數配置。 重要 當 Subtitle 為空白值時,會將第一路字幕流(若存在)直接拷貝到輸出檔案。 |
|
| Image | TargetImage |
否 |
截幀,截雪碧圖,媒體轉動圖參數配置。 |
|
| StripMetadata |
boolean |
否 |
去除媒體檔案 metadata,如 |
|
| UserData |
string |
否 |
使用者自訂資訊,在非同步訊息通知中會為您返回,用於方便您系統內對訊息通知進行關聯處理。最大長度為 2048 位元組。 |
{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"} |
| Tags |
object |
否 |
自訂標籤,用於對非同步任務進行搜尋、過濾。 |
{"test":"val1"} |
| CredentialConfig | CredentialConfig |
否 |
如無特殊需求,請保持留空即可。 鏈式授權配置。更多資訊,請參見使用鏈式授權訪問其他實體資源。 |
|
| Notification | Notification |
否 |
訊息通知配置,詳細內容請單擊 Notification 查看,非同步通知訊息格式請參見非同步通知訊息格式。 |
|
| AlignmentIndex |
integer |
否 |
在進行媒體拼接時,主媒體檔案(提供 |
0 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
響應結構體 |
||
| RequestId |
string |
請求 ID。 |
CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6 |
| EventId |
string |
事件 ID。 |
0ED-1Bz8z71k5TtsUejT4UJ16Es**** |
| TaskId |
string |
任務 ID。 |
MediaConvert-adb1ee28-c4c9-42a7-9f54-3b8eadcb**** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6",
"EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es****",
"TaskId": "MediaConvert-adb1ee28-c4c9-42a7-9f54-3b8eadcb****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。