視頻截圖完成 - ApsaraVideo VOD

本文為您介紹視頻截圖完成事件、事件通知的內容和回調樣本。

事件類型

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	是	視頻截圖狀態。 success：成功。 fail：失敗。
SubType	String	否	截圖子類型。取值：SpecifiedTime。說明 SubType=SpecifiedTime，表示通過提交媒體截圖作業介面發起的截圖。
ErrorCode	String	否	作業錯誤碼，視頻截圖失敗時，會有該欄位。
ErrorMessage	String	否	作業錯誤資訊，視頻截圖失敗時，會有該欄位。
CoverUrl	String	否	封面圖片地址。視頻截圖失敗時，不會有該欄位。
SnapshotInfos	SnapshotInfo[]	否	截圖列表。視頻截圖失敗時，不會有該欄位，具體結構請參見下文SnapshotInfos 截圖資料。
Extend	String	否	使用者自訂回調透傳資料。更多資訊，請參見媒體上傳自訂設定 UserData。

SnapshotInfos 截圖資料

參數名稱	類型	必填項	描述
Status	String	是	視頻截圖任務狀態。 success：成功。 fail：失敗。
SnapshotType	String	是	截圖類型。 CoverSnapshot：封面截圖。 NormalSnapshot：普通截圖。 SpriteSnapshot：雪碧截圖。更多資訊，請參見視頻截圖。
SnapshotCount	Long	是	截圖總數。
SnapshotFormat	String	是	截圖名稱格式。可使用OSS儲存地址或CDN網域名稱和該欄位資訊產生截圖地址。說明如果使用者存在網域名稱且網域名稱可能變動頻繁，可根據欄位資訊產生截圖具體地址。
SnapshotRegular	String	是	截圖地址規則。可根據規則產生截圖地址（推薦使用該欄位產生截圖地址），產生說明請參見下文截圖地址產生。說明截圖地址規則，有網域名稱則返回CDN地址規則，否則返回OSS地址規則，暫時不支援HTTPS地址規則返回。
JobId	String	是	截圖任務ID。

說明

最新上傳的視頻，截圖OSS儲存地址與視頻OSS儲存地址一致。更多資訊，請參見管理儲存Bucket。

截圖地址產生

提供兩種產生地址的方法：

根據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"
    }
  ]
}