文档反馈
文档反馈

云端录制事件

重要通知

网易云信新版文档中心现已正式上线!

音视频通话2.0互动直播2.0多人语音聊天室PK 直播等产品和场景方案已迁移至新版文档中心维护,欢迎体验!

事件类型

event_type 事件含义
300 服务器录制完成抄送
301 服务器录制服务发生错误
302 服务器录制服务状态发生变化
303 录制的音频流状态变化
304 录制的视频流状态变化
305 服务器录制失败

300 服务器录制完成抄送

服务器录制完成时,会触发此抄送。

字段说明

字段 类型 示例 说明
eventType Number 300 事件类型
channelId Number 43357868525520 被录制的房间 ID。
channelName String qaz 被录制的房间名称。
timestamp Number 1607001232517 该事件发生的 Unix 时间戳,单位为毫秒(ms)。
detail JSON - 具体的消息内容,JSON 类型,详细字段请查看下表。

detail 字段说明:

detail 字段 类型 示例 说明
uid Number 892576 用户 ID。
aDiscardRate Number 0 录制服务音频丢包比例。
vDiscardRate Number 0 录制服务视频丢包比例。
aFirstTs Number 20 第一个音频包原始时间戳。
vFirstTs Number 0 第一个视频包原始时间戳。
logoutTime Number 0 用户总退出时间。
largestW Number 720 最大分辨率宽。
largestH Number 1280 最大分辨率高。
aPkt Number 129 网络音频收包数。
vPkt Number 667 网络视频收包数。
vTotal Number 78 视频帧总数。
vDisorder Number 0 乱序视频帧数。
vError Number 0 错误视频帧数。
vLost Number 0 视频丢帧数。
vDump Number 78 视频落盘帧数。
vDecError Number 0 视频解码失败帧数。
aTotal Number 102 总音频包数。
aDisorder Number 0 乱序音频包数。
aLost Number 0 音频丢包数。
aDump Number 102 音频落盘包数。
aDecError Number 0 音频解码失败数。
dumpDisorder Number 0 落盘乱序包数。
avDelay Number 1 音视频不同步的包的数量。
tsFixed Number 0 修正时间戳包数。

JSON 示例

{
    "data":{
        "channelName":"qaz",
        "detail":[
            {
                "aFirstTs":20,
                "vTotal":78,
                "aDecError":0,
                "aDump":102,
                "largestW":720,
                "avDelay":1,
                "vDiscardRate":0,
                "tsFixed":0,
                "vDisorder":0,
                "vError":0,
                "aDiscardRate":0,
                "logoutTime":0,
                "uid":892576,
                "vFirstTs":0,
                "largestH":1280,
                "aPkt":129,
                "vDump":78,
                "vPkt":667,
                "dumpDisorder":0,
                "vLost":0,
                "aDisorder":0,
                "aTotal":102,
                "aLost":0,
                "vDecError":0
            }
        ],
        "channelId":43357868525520,
        "timestamp":1607001232517
    },
    "eventType":300
}

301 服务器录制服务发生错误

服务器录制过程中,如果发生错误,将会触发此抄送。

字段说明

字段 类型 示例 说明
eventType Number 301 事件类型
errorLevel Number 1 错误级别。包括:
  • 1:debug。
  • 2:minor。
  • 3:medium。
  • 4:major。
  • 5:fatal。
    fatal 级别的错误很可能导致录制退出,如果收到该级别的消息请及时调用 query API 查询当前状态,并结合错误消息的内容进行处理。
errorCode Number 1 错误码。返回1,表示 dump 文件写入失败。
channelName String 10086 被录制的房间名称。
channelId Number 43357244164048 被录制的房间 ID。
status Number 0 事件状态,0 表示正常,其他值表示异常。
timestamp Number 1606984002551 该事件发生时的 Unix 时间戳,单位为毫秒(ms)。

JSON 示例

{
    "data":{
        "errorLevel":"1",
        "errorCode":"1",
        "channelName":"10086",
        "channelId":"43357244164048",
        "status":0,
        "timestamp":1606984002551
    },
    "eventType":301
}

302 服务器录制服务状态发生变化

服务器录制服务状态发生变化时,会触发此抄送。

字段说明

字段 类型 示例 说明
eventType Number 302 事件类型。
channelName String 2005370 被录制的房间名称。
channelId Number 43357129934800 被录制的房间 ID。
status Number 2 云端录制服务是否正在接收音频流。包括:
  • 0:云端录制服务正在接收音频流。
  • 1:云端录制服务此刻没有接收音频流。
timestamp Number 1606984002243 该事件发生的 Unix 时间戳,单位为毫秒(ms)。

JSON 示例

{
    "data":{
        "channelName":"2005370",
        "channelId":"43357129934800",
        "status":2,
        "timestamp":1606984002243
    },
    "eventType":302
}

303 录制的音频流状态变化

录制的音频流状态发生变化时,会触发此回调。

字段说明

字段 类型 示例 说明
eventType Number 303 事件类型。
uid Number 459821 用户 UID,表示录制的是哪个用户的视频流。
channelName String 10086 被录制的房间名称。
channelId Number 43357244164048 被录制的房间 ID。
status Number 0 云端录制服务是否正在接收音频流。包括:
  • 0:云端录制服务正在接收音频流。
  • 1:云端录制服务此刻没有接收音频流。
timestamp Number 1606984002551 该事件发生的 Unix 时间戳,单位为毫秒(ms)。

JSON 示例

{
    "data":{
        "uid":"459821",
        "channelName":"10086",
        "channelId":"43357244164048",
        "status":0,
        "timestamp":1606984002551
    },
    "eventType":303
}

304 录制的视频流状态变化

录制的视频流状态发生变化时,会触发此消息抄送。

字段说明

字段 类型 示例 说明
eventType Number 304 事件类型。
uid Number 459821 用户 UID,表示录制的是哪个用户的视频流。
channelName String 10086 被录制的房间名称。
channelId Number 43357244164048 被录制的房间 ID。
status Number 0 云端录制服务是否正在接收音频流。包括:
  • 0:云端录制服务正在接收音频流。
  • 1:云端录制服务此刻没有接收音频流。
timestamp Number 1606984002415 该事件发生的 Unix 时间戳,单位为毫秒(ms)。

JSON 示例

{
    "data":{
        "uid":"459821",
        "channelName":"10086",
        "channelId":"43357244164048",
        "status":0,
        "timestamp":1606984002415
    },
    "eventType":304
}

305 服务器录制失败

服务器录制失败时,会触发此消息抄送。

字段说明

字段 类型 示例 说明
eventType Number 305 事件类型。
uid Number 1234 用户 UID,表示录制的是哪个用户的视频流。
channelId Number 234 被录制的房间 ID。
timestamp Number 1606974909978 该事件发生的 Unix 时间戳,单位为毫秒(ms)。
code Number 1 状态码。详细说明请参考状态码
channelName String abc 被录制的房间名称。
produceType String video 录制失败的流类型,包括:
  • audio:音频流。
  • video:音视频流。
  • screenshare:屏幕共享。

JSON 示例

{
  "eventType": 305,
  "data": {
    "uid":1234,
    "channelId":234,
    "timestamp":1606974909978,
    "code":1,
    "channelName":"abc",
    "produceType":"video"
 }
}

状态码

云端录制事件的相关回调中,状态码如下:

状态码(code) 说明
0 尚未开始云端录制。
1 dump 进程开始录制(创建房间)。
2 dump 录制切片。
3 dump 录制服务通话结束。
4 开始转码。
5 录制完成。
×

反馈成功

非常感谢您的反馈,我们会继续努力做得更好。