創建一個異步的媒體轉碼任務,提供媒體轉碼、媒體拼接、視頻截幀、視頻轉動圖等相關音視頻媒體文件處理能力。
接口說明
- 請確保在使用該接口前,已充分了解智能媒體管理產品的收費方式和價格。
- 調用該接口前,請確保當前 Region 已經存在可用的項目(Project),詳見項目管理。
注意 異步任務不保證時效。
- 使用該接口進行媒體轉碼時,默認只處理一路視頻/音頻/字幕流,同時支持配置處理的視頻/音頻/字幕流數量。
- 使用該接口進行媒體拼接時,最大支持的媒體數量為 11 個,此時配置的轉碼、截幀等參數將作用于拼接后媒體數據。
- 該接口為異步接口,獲取任務開始執行后,任務信息只保存 7 天,超過 7 天則無法再獲取。調用 GetTask 或 ListTasks 接口獲取返回的
TaskId
,查看任務信息。也可以通過設置 Notification 消息通知參數,通過消息通知獲取任務信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
imm:CreateMediaConvertTask | create | *Project acs:imm:{#regionId}:{#accountId}:project/{#ProjectName} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectName | string | 是 | 項目名稱,獲取方式請參見創建項目。 | test-project |
Sources | array<object> | 是 | 媒體文件列表。若列表元素大于 1 個則表示開啟 Concat(拼接)功能,Concat 順序為輸入視頻文件 URI 的順序。 | |
object | 是 | 源媒體文件。 | ||
URI | string | 否 | OSS 地址規則為 | oss://test-bucket/test-object |
StartTime | double | 否 | 媒體轉碼開始時間,單位為秒。取值范圍如下:
| 0 |
Duration | double | 否 | 媒體轉碼時長。單位為秒,默認值為 0,表示到視頻結束時間。 | 0 |
Subtitles | array<object> | 否 | 添加字幕列表,默認為空。 | |
object | 否 | 字幕信息。 | ||
URI | string | 否 | OSS 地址規則為 | oss://test-bucket/test-object |
TimeOffset | double | 否 | 字幕延遲時間,單位為秒,默認為 0。 | 10.5 |
Language | string | 否 | 字幕語言,參考標準為 ISO 639-2,默認為空。 | eng |
Targets | array<object> | 是 | 媒體處理任務列表,支持配置多任務。 | |
object | 是 | Targets 數組元素的詳細信息。 | ||
URI | string | 否 | 媒體轉碼輸出文件的 OSS 地址。 OSS 地址規則為
| oss://test-bucket/test-target-object.mp4 |
Container | string | 否 | 媒體容器類型。可選容器類型如下:
| mp4 |
Speed | float | 否 | 媒體倍速播放設置,取值范圍為[0.5,2],默認為 1.0。 說明
轉碼后媒體文件與源媒體文件默認播放速度的比值,非倍速轉碼。
| 1.0 |
Segment | object | 否 | 媒體切片設置,默認不進行切片。 | |
Format | string | 否 | 媒體切片方式。取值范圍如下:
| hls |
Duration | double | 否 | 切片長度。單位為秒。 | 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 | 否 | 在進行媒體拼接時,主媒體文件(提供 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6",
"EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es****",
"TaskId": "MediaConvert-adb1ee28-c4c9-42a7-9f54-3b8eadcb****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-05-09 | OpenAPI 入參發生變更 | 查看變更詳情 |
2023-04-03 | OpenAPI 入參發生變更 | 查看變更詳情 |
2023-03-09 | OpenAPI 入參發生變更 | 查看變更詳情 |
2022-08-16 | OpenAPI 入參發生變更 | 查看變更詳情 |
2022-08-16 | OpenAPI 入參發生變更 | 查看變更詳情 |