上传模块事件

更新时间

了解如何在云端录制中监听上传模块 Webhook 事件,以及各事件的类型和字段含义。

当 payload 中的 serviceType 返回 2 时,表示该回调事件与上传模块相关。

本页介绍上传模块相关的回调事件。如果你想查看其他云端录制的相关事件,可以参考回调事件概览。

上传模块回调包含如下事件:

eventType事件描述
30上传服务已启动
31所有录制文件已上传至指定的第三方云存储
32录制文件上传到声网备份云;新单流录制的 stranded 上传状态处理见下文
33录制文件上传到第三方云存储的进度;新单流录制(mode=raw)已移除此事件
45云端截图成功
表格内容超出当前宽度,可横向滚动查看更多列。

30 uploader_started

eventType 为 30 表示上传服务已启动, details 中包含以下字段:

  • msgName:String 类型,消息名称,即 uploader_started。
  • status:Number 类型,事件状态,0 表示正常,其他值表示异常。

31 uploaded

eventType 为 31 表示所有录制文件已上传至指定的第三方云存储, details 中包含以下字段:

  • msgName:String 类型,消息名称,即 uploaded。
  • status:Number 类型,事件状态,0 表示正常,其他值表示异常。
  • fileList:JSON Array,由每个录制文件的具体信息组成的数组。
    • fileName:String 类型,已经上传到指定三方云存储的录制文件名。
    • trackType:String 类型,录制文件的类型。
      • "audio":纯音频文件。
      • "video":纯视频文件。
      • "audio_and_video":音视频文件。
    • uid:String 类型,用户 ID,表示录制的是哪个用户的音频流或视频流。合流录制模式下,uid 为 "0"。
    • mixedAllUser:Boolean 类型,是否将所有用户合并录制。
      • true:所有用户合并在一个录制文件中。
      • false:每个用户分开录制。
    • isPlayable:Boolean 类型,是否可以在线播放。
      • true:可以在线播放。
      • false:无法在线播放。
    • sliceStartTime:Number 类型,该文件的录制开始时间,Unix 时间戳,单位为毫秒。

回调示例如下:

32 backuped

新单流录制的上传状态

新单流录制(mode=raw)新增 stranded 上传状态,表示部分录制文件尚未上传至指定的第三方云存储。录制服务会继续自动重试上传,直至上传成功;该状态不表示文件丢失。停止录制后,请检查 stop 响应中的 serverResponse.uploadingStatus。如果为 stranded,业务侧应保留“上传未完成”状态,等待文件上传完成后再进行依赖完整录制文件的播放或处理。

以下为 backuped 回调的含义、字段和示例。

eventType 为 32 表示所有录制文件已经全部上传完成,但至少有一片上传到声网备份云,声网备份云会自动将这部分文件上传到指定的第三方云存储。 details 中包含以下字段:

  • msgName:String 类型,消息名称,即 backuped。
  • status:Number 类型,事件状态,0 表示正常,其他值表示异常。
  • fileList:JSON Array,由每个录制文件的具体信息组成的数组。
    • fileName:String 类型,已经上传到指定三方云存储的录制文件名。
    • trackType:String 类型,录制文件的类型。
      • "audio":纯音频文件。
      • "video":纯视频文件。
      • "audio_and_video":音视频文件。
    • uid:String 类型,用户 ID,表示录制的是哪个用户的音频流或视频流。合流录制模式下,uid 为 "0"。
    • mixedAllUser:Boolean 类型,是否将所有用户合并录制。
      • true:所有用户合并在一个录制文件中。
      • false:每个用户分开录制。
    • isPlayable:Boolean 类型,是否可以在线播放。
      • true:可以在线播放。
      • false:无法在线播放。
    • sliceStartTime:Number 类型,该文件的录制开始时间,Unix 时间戳,单位为毫秒。

回调示例如下:

33 uploading_progress

新单流录制不支持此事件

新单流录制(mode=raw)已移除事件 33(uploading_progress),不会按分钟推送上传进度。迁移时,请移除对该事件的依赖。录制结束后,可通过 stop 响应中的 serverResponse.uploadingStatus 判断上传状态,并处理 stranded 状态。

以下说明适用于仍支持该事件的旧版及其他录制模式。

eventType 为 33 表示当前上传的进度,录制开始后每分钟会通知一次。 details 中包含以下字段:

  • msgName:String 类型,消息名称,即 uploading_progress。
  • progress:Number 类型,0 到 10000 之间的数字,当前已上传文件与已录制的文件的比例乘以 10000。这个数字是不断变动的,录制退出后,到达 10000 表示上传完成。

45 recorder_snapshot_file

新单流录制(mode=raw)的截图回调中,payload.serviceScene 为 "rtsc/raw-recording",不再使用旧版截图的 "rtc_snapshot"。事件编号仍为 45。

eventType 为 45 表示云端截图成功并上传至第三方云存储,details 中包含以下字段:

  • msgName:String 类型,消息名称,即 recorder_snapshot_file。
  • fileName: String 类型,截图生成的 JPG 文件的文件名。格式为:"fileName": "<fileNamePrefix>/<file name>"。其中 fileNamePrefix 指截图文件在第三方云存储中的存储位置。