SubmitSnapshotJob - 提交媒體截圖作業 -

調用本介面提交視頻截圖作業，開始非同步截圖處理。

介面說明

暫時只支援產生 JPG 格式的圖片。
截圖完成會產生 EventType=SnapshotComplete,SubType=SpecifiedTime 的視頻截圖完成的事件通知。

QPS 限制

本介面的單使用者 QPS 限制為 30 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。更多資訊，請參見 QPS 限制。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vod:SubmitSnapshotJob

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
VideoId	string	否	視頻 ID。可通過以下方式擷取：通過控制台上傳的視頻，可登入點播控制台，選擇媒資庫 > 音/視頻查看視頻 ID。通過擷取視頻上傳地址和憑證介面擷取上傳地址和憑證時，視頻 ID 為返回參數 VideoId 的值。視頻上傳後，可通過搜尋媒體資訊介面查詢視頻 ID，為請求後返回參數 VideoId 的值。	d3e680e618708efbf2cae7cc9312****
SpecifiedOffsetTime	integer	否	截圖指定時間的起始點。單位：毫秒。預設值：0。	0
Width	string	否	截圖寬，取值範圍：`[8,4096]`，預設原片寬，單位：px。	1280
Height	string	否	截圖高，取值範圍：`[8,4096]`，預設原片高，單位：px。	720
Count	integer	否	截圖的最大數量。預設值：1。	1
Interval	integer	否	截圖的間隔時間，必須大於或等於 0。單位：秒。預設值：1。 Interval 為 0 時，表示按照 Count 數根據視頻時間長度平均截圖。	1
SpriteSnapshotConfig	string	否	產生雪碧圖的配置資訊。如果不為空白則產生雪碧圖。參數結構詳情，請參見SpriteSnapshotConfig 。	{'CellWidth': 120, 'CellHeight': 68, 'Columns': 3,'Lines': 10, 'Padding': 20, 'Margin': 50}
SnapshotTemplateId	string	否	截圖模板 ID。推薦先建立截圖模板，再傳遞截圖模板 ID。截圖模板建立詳情，請參見添加截圖模板。如果傳遞截圖模板 ID，會忽略除 Action、VideoId 之外的請求參數。	f5b228fe693bf55bd87b789****
UserData	string	否	自訂設定。僅支援 JSON 字串，支援使用者自訂資料透傳及指定回調地址設定等。參數結構詳情，請參見 UserData 。說明此參數中訊息回調的使用前提是需要在控制台配置 HTTP 回調地址和勾選對應的回調事件類型才能使用，否則回調設定不生效。	{"MessageCallback":{"CallbackURL":"http://.example.aliyundoc.com"},"Extend":{"localId":"xxx","example":"www"}}
SpecifiedOffsetTimes	array	否	指定視頻時間點進行截圖，單位：毫秒。一次可指定最多 30 個時間點。
	integer	否	自訂時間點，毫秒	1000
ReferenceId	string	否	自訂 ID，僅支援小寫字母、大寫字母、數字、橫線、底線，長度 6-64 位元。使用者維度唯一。	123-123

說明

Count 和 Interval 至少指定一個，若同時指定，截圖數目以少者為準。

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	25818875-5F78-5EB0-4AF6-D7393642****
SnapshotJob	object	截圖作業資訊。
JobId	string	截圖作業 ID。	ad90a501b1b94b72374ad0050464****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "25818875-5F78-5EB0-4AF6-D7393642****",
  "SnapshotJob": {
    "JobId": "ad90a501b1b94b72374ad0050464****"
  }
}

錯誤碼

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

變更歷史

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