实时通信
事件类型
event_type | event_name | 事件含义 | payload 包含的字段 |
---|---|---|---|
101 | channel create | 创建频道。 | |
102 | channel destroy | 销毁频道。 | |
103 | broadcaster join channel | 直播场景下,主播加入频道。 | |
104 | broadcaster leave channel | 直播场景下,主播离开频道。 | |
105 | audience join channel | 直播场景下,观众加入频道。 | |
106 | audience leave channel | 直播场景下,观众离开频道。 | |
107 | user join channel with communication mode | 通信场景下,用户加入频道。 | |
108 | user leave channel with communication mode | 通信场景下,用户离开频道。 | |
111 | client role change to broadcaster | 直播场景下,加入频道后,用户将角色切换为主播。 | |
112 | client role change to audience | 直播场景下,加入频道后,用户将角色切换为观众。 |
payload 字段
字段名 | 类型 | 含义 |
---|---|---|
channelName | String | 频道名。 |
ts | Number | 该事件发生的 Unix 时间戳,单位为秒。 |
uid | Number | 用户使用的 UID。 |
platform | Number | 用户使用的设备类型: |
reason | Number | 用户离开频道的原因: |
channelSId | String | 频道Session ID,用于解决频道创建重复使用channelName的情况,使用该字段可记录频道的生命周期 。 |
uSId | String | 用户Session ID,用于解决一个用户重复进入频道的情况,使用该字段可记录用户每次进出频道的生命周期。 |
服务端推流到 CDN
事件类型
event_type | event_name | 事件含义 | payload 包含的字段 |
---|---|---|---|
1 | Publish Stream | 开始推流。 | |
2 | Unpublish Stream | 取消推流。 | |
3 | Publish Status | 推流状态改变。 | |
4 | Update Transcoding | 推流的转码布局设置已更新。 | |
5 | Publish Request | anyRTC 推流服务器收到开始推流的请求。 | |
6 | Publish First Frame | 视频首帧已推到 CDN。 |
payload 字段
字段名 | 类型 | 含义 |
---|---|---|
event | String | 推流事件:PublishStream :开始推流。UnpublishStream :取消推流。PublishStatus :推流状态改变。UpdateTranscoding :推流的转码布局设置已更新。PublishRequest : 推流服务器收到开始推流的请求。PublishFirstFrame :视频首帧已推到 CDN。 |
stream | String | 推流地址,支持 RTMP 协议。 Note:不支持中文字符等特殊字符,且该字符长度不能超过 1024 字节。 |
code | Number | 错误码:200 :推流成功。450 :非法参数。比如设置转码布局设置时,传入的参数与 anyRTC 要求的格式不同。451 :非法推流地址。请检查使用的流地址。452 :没有发起推流操作。比如推流过程中,更新转码布局后,没有再次调用推流接口。453 :不支持的操作。比如非转码推流时更新转码布局参数。454 :重复推流,已经存在该流地址。455 :超出最大允许推流的流数量(10个)。456 :没有权限的操作。比如删除别人的流。30 :RTMP handshake 失败。31 :RTMP connect 失败。32 :RTMP publish 失败。33 :TCP 连接断开。 |
time | Number | 该事件发生的 Unix 时间戳,单位为毫秒。 |
reason | String | 具体原因。 |
channel | String | 频道名。 |
videoCodec | String | 输出视频的编码格式: |
videoProfile | String | 输出视频的编码规格: |
uid | String | 用户的 UID。 |
width | Number | 输出视频的宽度(px)。 |
height | Number | 输出视频的高度(px)。 |
audioCodec | String | 输出音频的编码标准:AAC 。 |
audioProfile | String | 输出音频的编码规格: |
audioChannels | Number | 输出音频的声道数。 |
audioSampleRate | Number | 输出音频的采样率(Hz)。 |
elapse | Number | 首帧推流所耗时间(ms),即从 anyRTC 推流服务器收到推流请求(PublishRequest )到输出视频首帧(PublishFirstFrame )的时间。 |
retry | Boolean | 是否为重新推流:true :重新推流。false :首次推流。Note:此处的重新推流指 anyRTC 服务器尝试重新推流,不是用户调用推流接口重复推流。用户重复推流时会收到错误码 454 。 |