本文為您介紹視頻截圖完成事件、事件通知的內容和回調示例。
事件類型
SnapshotComplete
事件說明
視頻截圖完成后會產生SnapshotComplete事件。
截圖和轉碼是并行處理，二者無法確定先后順序。
如果是封面截圖類型，并且沒有設置視頻封面（CoverUrl），則默認取截圖的中間一張為視頻封面。關于封面截圖，更多信息，請參見視頻截圖。
您也可以通過獲取視頻信息接口，獲取視頻封面和CoverSnapshot類型的截圖地址。
您還可以通過查詢截圖數據接口，獲取指定視頻最新一次截圖的截圖地址。
如果開啟了URL鑒權，則需要自己生成auth_key才能訪問圖片地址，否則會返回HTTP 403。URL鑒權的信息，請參見URL鑒權。
事件內容
參數名稱 | 類型 | 必備項 | 描述 |
EventTime | String | 是 | 事件產生時間，為UTC時間：yyyy-MM-ddTHH:mm:ssZ。 |
EventType | String | 是 | 事件類型，系統規定參數。固定為：SnapshotComplete。 |
VideoId | String | 是 | 視頻ID。 |
Status | String | 是 | 視頻截圖狀態。
|
SubType | String | 否 | 截圖子類型。取值：SpecifiedTime。 說明 SubType=SpecifiedTime，表示通過提交媒體截圖作業接口發起的截圖。 |
ErrorCode | String | 否 | 作業錯誤碼，視頻截圖失敗時，會有該字段。 |
ErrorMessage | String | 否 | 作業錯誤信息，視頻截圖失敗時，會有該字段。 |
CoverUrl | String | 否 | 封面圖片地址。視頻截圖失敗時，不會有該字段。 |
SnapshotInfos | SnapshotInfo[] | 否 | 截圖列表。視頻截圖失敗時，不會有該字段，具體結構請參見下文SnapshotInfos 截圖數據。 |
Extend | String | 否 | 用戶自定義回調透傳數據。更多信息，請參見媒體上傳自定義設置 UserData。 |
SnapshotInfos 截圖數據
參數名稱 | 類型 | 必填項 | 描述 |
Status | String | 是 | 視頻截圖任務狀態。
|
SnapshotType | String | 是 | 截圖類型。
更多信息，請參見視頻截圖。 |
SnapshotCount | Long | 是 | 截圖總數。 |
SnapshotFormat | String | 是 | 截圖名稱格式。可使用OSS存儲地址或CDN域名和該字段信息生成截圖地址。 說明 如果用戶存在域名且域名可能變動頻繁，可根據字段信息生成截圖具體地址。 |
SnapshotRegular | String | 是 | 截圖地址規則。可根據規則生成截圖地址 （推薦使用該字段生成截圖地址），生成說明請參見下文截圖地址生成。 說明 截圖地址規則，有域名則返回CDN地址規則，否則返回OSS地址規則，暫時不支持HTTPS地址規則返回。 |
JobId | String | 是 | 截圖任務ID。 |
最新上傳的視頻，截圖OSS存儲地址與視頻OSS存儲地址一致。更多信息，請參見存儲管理。
截圖地址生成
提供兩種生成地址的方法：
根據SnapshotFormat生成截圖地址
地址規則：http(s)://{CDN域名或OSS存儲地址}/SnapshotFormat。
生成說明：{SnapshotCount}為對應每張截圖的序列號（固定5位寬度，不足以0補齊）。
示例：
第一張截圖序列號為：00001，則地址為：
http://example.com/2327a6ec24b44844b3a5e2c1b691****/covers/990f3820db2948b5b4a13d65d9a4****-00001.jpg。第二張截圖序列號為：00002，則地址為：
http://example.com/2327a6ec24b44844b3a5e2c1b691****/covers/990f3820db2948b5b4a13d65d9a4****-00002.jpg。以此類推。
根據SnapshotRegular生成截圖地址
地址規則：SnapshotRegular已經為完整的地址規則。
生成說明：同SnapshotFormat截圖具體地址的生成說明。
回調示例
回調示例說明：
對于HTTP回調，以下內容為HTTP Post Body。
對于MNS回調，以下內容為消息體。
{
"EventType": "SnapshotComplete",
"EventTime": "2018-07-31T10:07:31Z",
"CoverUrl": "http://sample/covers/990f3820db2948b5b4a13d65d9a4****-00002.jpg",
"Extend":"test data",
"SnapshotInfos": [
{
"Status": "success",
"SnapshotType": "CoverSnapshot",
"SnapshotCount": 2,
"SnapshotFormat": "2327a6ec24b44844b3a5e2c1b691****/covers/990f3820db2948b5b4a13d65d9a4****-{SnapshotCount}.jpg",
"SnapshotRegular": "http://sample/covers/990f3820db2948b5b4a13d65d9a4****-{SnapshotCount}.jpg",
"JobId": "ee16d4bbf3f7*****e094bcb8cf8ddde"
},
{
"Status": "success",
"SnapshotType": "SpriteSnapshot",
"SnapshotCount": 1,
"SnapshotFormat": "2327a6ec24b44844b3a5e2c1b691****/covers/sprite/990f3820db2948b5b4a13d65d9a4****-{SnapshotCount}.jpg",
"SnapshotRegular": "http://sample/covers/sprite/990f3820db2948b5b4a13d65d9a4****-{SnapshotCount}.jpg",
"JobId": "b3187205eed*****b72adf4eb3840713"
}
]
}