文档转码事件

最近更新时间:2019-12-18 15:32:42

转码进度

事件名称

TranscodeProgressChanged

事件说明

当文档转码进度发生改变时通知 App 后台

EventData 结构定义:

参数名称 类型 描述
TaskId String 发生进度改变的文档 TaskId
Progress String 当前转码进度
Resolution String 文档分辨率,在文档转码服务解析出文件分辨率之前改值为空字符串
Title String 文档标题,在文档转码服务解析出文件标题之前改值为空字符串
Pages Integer 文档总页数,在文档转码服务解析出文件总页数之前改值为0

示例

{
  "Timestamp": 1575545412,
  "EventType": "TranscodeProgressChanged",
  "EventData": {
    "TaskId": "bj0mt2l23osdj300hl30",
    "Progress": 24,
    "Resolution": "1024x768",
    "Title": "测试.ppt",
    "Pages": 16
  }
}

转码结束

事件名称

TranscodeFinished

事件说明

当文档转码完成时通知 App 后台

EventData 结构定义:

参数名称 类型 描述
TaskId String 转码完成的文档 TaskId
Progress String 当前转码进度,转码完成固定为100
Resolution String 文档分辨率
Title String 文档标题
Pages Integer 文档总页数
Error.Code String 如果文档转码发生错误会有该字段,具体错误码描述请参考接口文档 查询文档转码任务
Error.Message String 如果文档转码发生错误的具体错误描述

示例

示例1 转码成功的回调

{
  "Timestamp": 1575545412,
  "EventType": "TranscodeFinished",
  "EventData": {
    "TaskId": "bj0mt2l23osdj300hl30",
    "Progress": 100,
    "Resolution": "1024x768",
    "Title": "测试.ppt",
    "Pages": 16,
    "ResultUrl": "https://transcode-result/0agdnligqtgtvkm65emb/index.html",
    "ThumbnailUrl": "https://transcode-thumbnal/0agdnligqtgtvkm65emb/",
    "ThumbnailResolution": "793x1122",
    "CompressFileUrl": ""
  }
}

示例2 转码失败的回调

{
  "Timestamp": 1575545412,
  "EventType": "TranscodeFinished",
  "EventData": {
    "Error": {
      "Code": "InvalidParameter.UrlFormatError",
      "Message": "文档下载 URL 不合法"
    }
  }
}