客户端事件通知（ClientEvent）
本章节介绍了Web SDK的ClientEvent事件。
序号 |
接口 |
描述 |
1 |
peer-join |
远端用户进入房间事件。 |
2 |
peer-leave |
远端用户退出房间事件。 |
3 |
stream-added |
远端流添加事件。 |
4 |
stream-removed |
远端流删除事件。 |
5 |
stream-updated |
远端流更新事件。 |
6 |
stream-subscribed |
远端流订阅成功事件。 |
7 |
client-banned |
用户被踢，离开房间事件。 |
8 |
error |
客户端出现错误事件。 |
9 |
mute-audio |
远端流禁用音频通知事件。 |
10 |
unmute-audio |
远端流启用音频通知事件。 |
11 |
mute-video |
远端流禁用视频通知事件。 |
12 |
unmute-video |
远端流启用视频通知事件。 |
13 |
signature-expired |
签名过期事件。 |
14 |
camera-changed |
摄像头设备变更事件。 |
表7.3.4.3-1 ClientEvent事件
peer-join
【事件说明】
远端用户加入房间事件，远端用户加入房间后会收到该事件通知。
【事件参数】
peerJoinEvent：必选，PeerJoin类型，用户信息。
PeerJoin定义为：{
userId：必选，string[128]类型，用户标识。
}
peer-leave
【事件说明】
远端用户离开房间事件，远端用户离开房间后会收到该事件通知。
【事件参数】
peerLeaveEvent：必选，PeerLeaveInfo类型，用户离开信息。
PeerLeaveInfo定义为：{
userId：必选，string[128]类型，用户标识。
reason：可选，ByeReason类型。
}
ByeReason定义为：{
code：number类型, 离开原因枚举，取值如表2所示。
msg: string类型，原因描述。
}
枚举值 |
描述 |
|---|---|
0 |
用户主动离开 |
1 |
服务器异常 |
2 |
sfu服务故障 |
3 |
服务不可达503 |
4 |
内部错误 |
5 |
被踢出房间 |
6 |
签名过期 |
7 |
重连超时 |
8 |
网络检测，UI不需要关注该错误码，不对外体现 |
9 |
用户移除 |
10 |
房间解散 |
表7.3.4.3-2 离开房间原因
stream-added
【事件说明】
远端流添加事件，当选看远端用户成功后会收到该事件通知。
【事件参数】
stream：必选，Stream类型，远端流对象。
stream-removed
【事件说明】
远端流删除事件，当取消选看远端用户或者原来已经选看的远端用户退出房间后会收到该事件通知。
【事件参数】
stream：必选，Stream类型，远端流对象。
stream-updated
【事件说明】
远端流更新事件，当远端用户的流发生变化，例如添加或者移除音视频轨，视频轨规格变化时会收到该事件通知。
【事件参数】
stream：必选，Stream类型，远端流对象。
stream-subscribed
【事件说明】
远端流订阅成功事件，当订阅远端流成功后会收到该事件通知。
【事件参数】
stream：必选，Stream类型，远端流对象。
stream-published
【事件说明】
本地流推送服务器成功
【事件参数】
stream：必选，Stream类型，本地流对象
error
【事件说明】
客户端错误事件，当出现不可恢复的错误后，Client会上报该事件通知。
【事件参数】
errorInfo：必选，ErrorInfo类型，错误信息。
ErrorInfo定义为：{
errorCode：必选，string类型，错误码。
errorMsg：必选，string类型，错误描述。
}
mute-audio
【事件说明】
远端用户禁用音频通知事件，当远端用户禁用音频后，流的接收端会收到该事件通知。
【事件参数】
mediaStatus：必选，MediaStatusNotifyInfo类型。
MediaStatusNotifyInfo包含如下属性：
roomId：必选，类型string。
userId：必选，类型string。
unmute-audio
【事件说明】
远端用户启用音频通知事件，当远端用户启用音频后，流接收端会收到该事件通知。
【事件参数】
mediaStatus：必选，MediaStatusNotifyInfo类型。
mute-video
【事件说明】
远端用户禁用视频通知事件，当远端用户禁用视频后，流接收端会收到该事件通知。
【事件参数】
mediaStatus：必选，MediaStatusNotifyInfo类型。
unmute-video
【事件说明】
远端用户启用视频通知事件，当远端用户启用视频后，流接收端会收到该事件通知。
【事件参数】
mediaStatus：必选，MediaStatusNotifyInfo类型。
