服务端 API 文档

指定时间点截图完成

最近更新时间:2021-04-13 15:47:53

注意:

  • 本文档为3.0版本的格式回调,2.0版本的历史格式回调请参见 历史格式回调 文档。
  • 建议您将回调版本逐步迁移到3.0格式,2.0格式回调的文档将不再维护。

事件名称

CreateSnapshotByTimeOffsetComplete

事件说明

当 App 配置了事件通知,并且在指定时间点截图完成后,App 后台即可通过“普通回调”或“可靠回调”的方式获取该事件通知。事件通知内容为 SnapshotByTimeOffsetTask2017 结构

普通回调

如果选择普通回调模式,则回调 URL 会接收到如下形式的 HTTP 请求。

{
   "EventType":"CreateSnapshotByTimeOffsetComplete",
   "FileUploadEvent":null,
   "ProcedureStateChangeEvent":null,
   "FileDeleteEvent":null,
   "PullCompleteEvent":null,
   "EditMediaComplete":null,
   "WechatPublishComplete":null,
   "TranscodeCompleteEvent":null,
   "ConcatCompleteEvent":null,
   "ClipCompleteEvent":null,
   "CreateImageSpriteCompleteEvent":null,
   "SnapshotByTimeOffsetCompleteEvent":{
       "TaskId":"CreateSnapshotByTimeOffset-1edb7eb88a599d05abe451cfc541cfbd",
       "FileId":"14508071098244929440",
       "Definition":10,
       "SnapshotInfoSet":[
           {
               "ErrCode":0,
               "TimeOffset":10000,
               "Url":"http://125676836723.vod2.myqcloud.com/xxx/xxx/1.png"
           },
           {
               "ErrCode":0,
               "TimeOffset":20000,
               "Url":"http://125676836723.vod2.myqcloud.com/xxx/xxx/2.png"
           }
       ]
   }
}

可靠回调

如果选择可靠回调模式,调用 拉取事件通知 API 会接收到如下形式的 HTTP 应答。

{
   "Response":{
       "EventSet":[
           {
               "EventHandle":"EventHandle.N",
               "EventType":"CreateSnapshotByTimeOffsetComplete",
               "FileUploadEvent":null,
               "ProcedureStateChangeEvent":null,
               "FileDeleteEvent":null,
               "PullCompleteEvent":null,
               "EditMediaComplete":null,
               "WechatPublishComplete":null,
               "TranscodeCompleteEvent":null,
               "ConcatCompleteEvent":null,
               "ClipCompleteEvent":null,
               "CreateImageSpriteCompleteEvent":null,
               "SnapshotByTimeOffsetCompleteEvent":{
                   "TaskId":"CreateSnapshotByTimeOffset-1edb7eb88a599d05abe451cfc541cfbd",
                   "FileId":"14508071098244929440",
                   "Definition":10,
                   "SnapshotInfoSet":[
                       {
                           "ErrCode":0,
                           "TimeOffset":10000,
                           "Url":"http://125676836723.vod2.myqcloud.com/xxx/xxx/1.png"
                       },
                       {
                           "ErrCode":0,
                           "TimeOffset":20000,
                           "Url":"http://125676836723.vod2.myqcloud.com/xxx/xxx/2.png"
                       }
                   ]
               }
           }
       ],
    "RequestId": "335bdaa3-db0e-46ce-9946-51941d9cb0f5"
   }
}
目录