CreateHighlightTask

建立高光任務，邀測中。

介面說明

請確保在使用該介面前，已充分了解智慧媒體管理產品的收費方式和價格，會產生高光提取和媒體處理的費用。
呼叫該介面前，請確保當前 Region 已經存在可用的專案（Project），詳見專案管理。
重要非同步任務不保證時效。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

imm:CreateHighlightTask

create

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
ProjectName	string	是	專案名稱。	immtest
Sources	array<object>	是	需要處理的媒體資源清單。上限 10 個影片。
	object	否	需要處理的媒體資源。
URI	string	是	媒體資源 URI（OSS URI）。目前僅支援影片。	oss://test-bucket/test-object
StartTime	number	否	媒體資源的開始時間。取值範圍 [0, 影片時長]。僅當 Type 為 Concat 時有效。單位為秒。	0
Duration	number	否	媒體片段時長。單位為秒，預設值為 0，表示到影片結束時間。僅當 Type 為 Concat 時有效。	0
Mode	string	否	高光識別模式。 Scene：場景和幀識別 Average（預設）：平均切片識別	Average
Type	string	是	處理類型。 Retrieval：高光提取 Concat：影片合成 Compose：一鍵成片	Retrieval
Highlight	object	否	高光設定。
Content	string	是	高光內容。寵物人物運動會議長度不能超過 100 字元。	character
Edit	object	否	剪輯設定。
Mode	string	是	剪輯模式。 Sequential：順序模式	Sequential
BackgroundMusicMode	string	否	背景音樂模式。預設 Closed。 Random：自訂背景音樂，根據權重隨機選擇 Sequential：自訂背景音樂，根據順序套用背景音樂 Closed：無背景音樂	Closed
BackgroundMusics	array<object>	否	背景音樂。當 BackgroundMusicMode 為 Random 和 Sequential 時有效。目前數量上限是 1。
	object	否	背景音樂。
URI	string	是	背景音樂 URI（OSS URI）。目前僅支援音訊。	oss://test-bucket/test-object/test.mp3
Volume	number	否	背景音樂的音量強度。取值：[0, 10]。預設 0.2。若為 1 則表示使用原始聲音強度。	0.2
TransitionMode	string	否	轉場模式。預設 Closed。 Auto：自動轉場 Random：自訂轉場，根據權重隨機選擇 Sequential：自訂轉場，根據順序套用轉場 Closed：無轉場	Closed
Transitions	array<object>	否	轉場效果。當 TransitionMode 為 Random 和 Sequential 時有效。數量上限 10。
	object	否
Transition	string	是	轉場效果。見：轉場清單	fade
Duration	number	否	轉場時長，單位秒。如果轉場時長 > 片段時長 - 1，則該片段上的轉場效果不會生效。取值範圍 [0, 5]。	0
Weight	integer	否	轉場權重。取值 [1, 100]。預設 50。當 TransitionMode 為 Random 時有效。	50
VfxEffectMode	string	否	特效模式。預設 Closed。 Auto：自動特效 Random：自訂特效，根據權重隨機選擇 Sequential：自訂特效，根據順序套用特效 Closed：無特效	Closed
VfxEffects	array<object>	否	視覺特效。當 VfxEffectMode 為 Random 和 Sequential 時有效。數量上限 10。
	object	否
VfxEffect	string	是	視覺特效。見：特效清單	letterboxed
Weight	integer	否	轉場權重。取值 [1, 100]。預設 50。當 VfxEffectMode 為 Random 時有效。	50
Output	object	是	輸出設定。
URI	string	是	輸出檔案的地址。	oss://test-bucket/test-target-object.mp4
Container	string	否	當 Type 為 Concat 或者 Compose 時，Container 必填。媒體容器類型。可選容器類型如下：影音容器：mp4、mkv、mov、asf、avi、mxf、ts、flv 重要 Container 與 URI 參數需要同時設定。	mp4
Speed	number	否	媒體倍速播放設定，取值範圍為 [0.5, 1.0]，預設為 1.0。說明轉碼後媒體檔案與來源媒體檔案預設播放速度的比值，非倍速轉碼。	1.0
Segment	object	否	媒體切片設定。預設不進行切片。
Format	string	否	媒體切片方式。取值範圍如下： hls dash	hls
Duration	number	否	切片長度。單位為秒。	1
StartNumber	integer	否	起始序號，僅支援 hls，預設為 0。	0
Video	TargetVideo	否	影片處理參數設定。重要當 Video 為空值時，會將第一路影片串流（若存在）直接複製到輸出檔案。
Audio	TargetAudio	否	音訊處理參數設定。重要當 Audio 為空值時，會將第一路音訊串流（若存在）直接複製到輸出檔案。
MaxDuration	number	否	剪輯影片的最大時長，單位秒。	10.0
UserData	string	否	使用者自訂資訊，在非同步訊息通知中會返回。	{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}
Tags	object	否	自訂標籤，用於對非同步任務進行搜尋、篩選。	{"test":"val1"}
CredentialConfig	CredentialConfig	否	鏈式授權設定。如無特殊需求，請保持留空即可
Notification	Notification	否	訊息通知設定，詳細內容請按一下 Notification 檢視，非同步通知訊息格式請參見非同步通知訊息格式。

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6
EventId	string	事件 ID。	0ED-1Bz8z71k5TtsUejT4UJ16Es****
TaskId	string	任務 ID。	Highlight-4d51241b-04d4-4343-aa25-****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es****",
  "TaskId": "Highlight-4d51241b-04d4-4343-aa25-****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。