全部产品
云市场

视频截图完成

更新时间:2018-12-19 15:32:41

事件类型

SnapshotComplete

事件说明

视频截图完成后会产生SnapshotComplete事件。

注:

  • 截图和转码是并行处理,二者无法确定先后顺序。
  • 如果是 封面截图 类型并且没有设置视频封面(CoverUrl),则默认取截图的中间一张为视频封面。
  • 您也可以通过 获取视频信息 接口获取视频封面和CoverSnapshot类型的截图地址。
  • 您还可以通过 ListSnapshots 接口获取指定视频最新一次截图的截图地址。
  • 如果开启了 URL鉴权,则需要自己生成auth_key才能访问图片地址,否则会返回HTTP 403。

事件内容

名称 类型 必填项 描述
EventTime String 事件产生时间, 为UTC时间:yyyy-MM-ddTHH:mm:ssZ
EventType String 事件类型,固定为SnapshotComplete
VideoId String 视频ID
Status String 视频截图状态,取值:success(成功),fail(失败)
SubType String 截图子类型,取值:SpecifiedTime
ErrorCode String 视频截图失败时,会有该字段表示出错代码
ErrorMessage String 视频截图失败时,会有该字段表示出错信息
CoverUrl String 封面图片地址,截图失败不会有该字段
SnapshotInfos SnapshotInfo[] 截图列表,截图失败不会有该字段

说明:

SnapshotInfo 截图数据

名称 类型 必填项 描述
Status String 视频截图任务状态,取值:success(成功),fail(失败)
SnapshotType String 截图类型:CoverSnapshot(封面截图)、NormalSnapshot(普通截图)、SpriteSnapshot(雪碧截图)
SnapshotCount Long 截图总数
SnapshotFormat String 截图名称格式,可使用OSS存储地址或CDN域名和该字段信息生成截图地址
SnapshotRegular String 截图地址规则,可根据规则生成截图地址 (推荐使用该字段生成截图地址)
JobId String 截图任务ID

说明:

  • SnapshotType详细描述请参考 视频截图
  • SnapshotFormat 如果用户存在域名且域名可能变动频繁,可根据字段信息生成截图具体地址。
  • SnapshotRegular 截图地址规则,有域名则返回CDN地址规则,否则返回OSS地址规则,暂时不支持https地址规则返回。
  • 最新上传的视频,截图OSS存储地址与视频OSS存储地址一致,详细请参考 存储管理

截图地址生成

根据SnapshotFormat生成截图地址

根据SnapshotRegular生成截图地址

  • 地址规则:SnapshotRegular已经为完整的地址规则。
  • 生成说明:同SnapshotFormat截图具体地址的生成说明。

回调示例

说明:

  • 对于HTTP回调,以下内容为HTTP Post Body
  • 对于MNS回调,以下内容为消息体
  1. {
  2. "EventType": "SnapshotComplete",
  3. "EventTime": "2018-07-31T10:07:31Z",
  4. "CoverUrl": "http://sample/covers/990f3820db2948b5b4a13d65d9a449f6-00002.jpg",
  5. "SnapshotInfos": [
  6. {
  7. "Status": "success",
  8. "SnapshotType": "CoverSnapshot",
  9. "SnapshotCount": 2,
  10. "SnapshotFormat": "2327a6ec24b44844b3a5e2c1b691fdba/covers/990f3820db2948b5b4a13d65d9a449f6-{SnapshotCount}.jpg",
  11. "SnapshotRegular": "http://sample/covers/990f3820db2948b5b4a13d65d9a449f6-{SnapshotCount}.jpg",
  12. "JobId": "ee16d4bbf3f740089e094bcb8cf8ddde"
  13. },
  14. {
  15. "Status": "success",
  16. "SnapshotType": "SpriteSnapshot",
  17. "SnapshotCount": 1,
  18. "SnapshotFormat": "2327a6ec24b44844b3a5e2c1b691fdba/covers/sprite/990f3820db2948b5b4a13d65d9a449f6-{SnapshotCount}.jpg",
  19. "SnapshotRegular": "http://sample/covers/sprite/990f3820db2948b5b4a13d65d9a449f6-{SnapshotCount}.jpg",
  20. "JobId": "b3187205eed647ebb72adf4eb3840713"
  21. }
  22. ]
  23. }