NERoom-web-SDK

网易云信 NERoom Web SDK

简介

网易云信 NERoom SDK 以房间为基础,提供网易云信全系列能力,包括即时消息、音视频通话、直播、互动白板等,并提供易接入、强扩展、高效部署且覆盖多场景的服务。NERoom 通过组件与 UI kit,助力您快速搭建业务场景,例如多人语聊房、秀场直播、电商直播、在线教育、企业培训、活动直播等。

NERoom

方法 功能 起始版本
initialize NERoom 初始化 V1.0.0
release NERoom 销毁 V1.0.0
authService 获取鉴权服务,提供登录、登出能力 V1.3.0
roomService 获取房间服务,提供创建、加入房间能力 V1.3.0
messageChannelService 获取消息通道服务,提供房间内发送自定义消息能力 V1.3.0
switchLanguage 切换语言 V1.10.0
getInstance NERoom 获取实例 V1.7.0

房间管理

方法 功能 起始版本
createRoom 创建房间 V1.0.0
joinRoom 进入房间 V1.0.0
leaveRoom 离开房间 V1.0.0
endRoom 删除房间 V1.0.0

房间事件

事件 描述 起始版本
onMemberAudioMuteChanged 成员音频状态回调 V1.0.0
onMemberJoinChatroom 成员加入聊天室回调 V1.0.0
onMemberJoinRoom 成员进入房间回调 V1.0.0
onMemberJoinRtcChannel 成员加入 RTC 频道回调 V1.0.0
onMemberLeaveChatroom 成员离开聊天室回调 V1.0.0
onMemberLeaveRoom 成员离开房间回调 V1.0.0
onMemberLeaveRtcChannel 成员离开 RTC 频道回调 V1.0.0
onMemberRoleChanged 成员角色变更回调 V1.0.0
onMemberScreenShareStateChanged 成员屏幕共享状态回调 V1.0.0
onMemberVideoMuteChanged 成员视频状态回调 V1.0.0
onReceiveChatroomMessages 聊天室消息回调 V1.0.0
onRoomEnded 房间结束回调 V1.0.0
onRtcChannelError RTC 频道错误回调 V1.0.0
onRoomPropertiesChanged 房间属性变更回调 V1.1.0
onRoomPropertiesDeleted 房间属性删除回调 V1.1.0
onMemberNameChanged 成员属性变更回调 V1.1.0
onMemberPropertiesChanged 成员昵称修改回调 V1.1.0
onMemberPropertiesDeleted 成员属性删除回调 V1.1.0
onRtcActiveSpeakerChanged 当前房间成员音量最大者回调 V1.1.0
onRtcAudioVolumeIndication 当前房间成员说话者瞬时音量回调 V1.1.0
onRoomLockStateChanged 房间锁定状态变更事件回调 V1.1.0
onRoomConnectStateChanged 网络状态变更回调 V1.1.0
onRtcNetworkQuality 网络状态变更回调 V1.1.0
onCameraDeviceChanged 摄像头设备变更回调 V1.1.0
onPlayoutDeviceChanged 扬声器设备变更回调 V1.1.0
onRecordDeviceChanged 麦克风设备变更回调 V1.1.0
onChatroomMessageAttachmentProgress 远端用户开启音频辅流回调 V1.9.0
onRtcUserAudioSubStreamStop 远端用户关闭音频辅流回调 V1.8.0

成员管理

方法 功能 起始版本
NERoomContext#localMember 本端成员信息 V1.0.0
NERoomContext#remoteMembers 远端成员信息 V1.0.0
NERoomContext#kickMemberOut 移除成员 V1.0.0
NERoomContext#changeMemberRole 修改成员角色 V1.0.0
NERoomContext#handOverMyRole 移交角色 V1.1.0
NERoomContext#updateMemberProperty 更新成员属性 V1.1.0
NERoomContext#deleteMemberProperty 删除成员属性 V1.1.0

音视频通话

方法 功能 起始版本
NERtcController#joinRtcChannel 加入音视频房间 V1.0.0
NERtcController#leaveRtcChannel 退出音视频房间 V1.0.0
NERtcController#unmuteMyVideo 打开本地视频 V1.0.0
NERtcController#muteMyVideo 关闭本地视频 V1.0.0
NERtcController#muteMemberVideo 关闭成员视频 V1.0.0
NERtcController#unmuteMemberVideo 打开成员视频 V1.0.0
NERtcController#unmuteMyAudio 打开本地音频 V1.0.0
NERtcController#muteMyAudio 关闭本地音频 V1.0.0
NERtcController#muteMemberAudio 关闭成员音频 V1.0.0
NERtcController#unmuteMemberAudio 打开成员音频 V1.0.0
NERtcController#adjustRecordingSignalVolume 调节本端采集音量 V1.9.0
NERtcController#pauseAllEffects 暂停播放所有音效文件 V1.9.0
NERtcController#pauseEffect 暂停播放指定音效文件 V1.9.0
NERtcController#resumeEffect 恢复播放指定音效文件 V1.9.0
NERtcController#resumeAllEffects 恢复播放所有音效文件 V1.9.0
NERtcController#getEffectDuration 获取音效文件时长 V1.9.0
NERtcController#setChannelProfile 设置房间场景 V1.9.0
NERtcController#setAudioProfile 设置音频编码属性 V1.9.0
NERtcController#enableLocalSubstreamAudio 开启音频辅流 V1.9.0
NERtcController#disableLocalSubstreamAudio 关闭音频辅流 V1.9.0
NERtcController#pauseLocalAudioRecording 暂停本地麦克风采集 V1.12.0
NERtcController#resumeLocalAudioRecording 恢复本地麦克风采集 V1.12.0
NERtcController#pauseLocalVideoCapture 暂停本地视频采集 V1.12.0
NERtcController#resumeLocalVideoCapture 恢复本地视频采集 V1.12.0
NERtcController#adjustPlaybackSignalVolume 调节所有远端用户的音量 V1.12.0

即时消息

方法 功能 起始版本
NEChatController#joinChatroom 进入聊天室 V1.0.0
NEChatController#leaveChatroom 离开聊天室 V1.0.0
NEChatController#sendBroadcastTextMessage 发送广播消息 V1.0.0
NEChatController#sendDirectTextMessage 发送定向消息(单人) V1.0.0
NEChatController#sendGroupTextMessage 发送多人消息 V1.0.0
NEChatController#sendImageMessage 发送图片消息 V1.8.0
NEChatController#sendFileMessage 发送文件消息 V1.8.0
NEChatController#cancelSendFileMessage 取消发送文件消息 V1.8.0

互动白板

方法 功能 起始版本
NEWhiteboardController#initWhiteboard 初始化白板 V1.0.0
NEWhiteboardController#startWhiteboardShare 开始共享白板 V1.0.0
NEWhiteboardController#setupWhiteboardCanvas 绑定白板视图 V1.0.0
NEWhiteboardController#setEnableDraw 设置白板是否可绘制 V1.0.0
NEWhiteboardController#getWhiteboardSharingUserUuid 查询白板共享者的 userUuid V1.0.0
NEWhiteboardController#stopWhiteboardShare 停止共享白板 V1.0.0
NEWhiteboardController#stopMemberWhiteboardShare 停止成员共享白板 V1.0.0

错误码

在调用 SDK API 的过程中,SDK 可能会返回错误码或状态码,您可以根据错误码或状态码判断当前 SDK 或任务的状态。如果遇到未知的错误码,请联系技术支持排查。 当前 SDK API 的错误码如下:

错误码 描述
0 Success
-1 NERoom SDK 通用错误
400 参数非法
401 鉴权失败 未认证
402 鉴权失败 token 错误
403 房间操作权限禁止
404 房间操作权限未找到
406 鉴权失败 token 过期
409 创建房间时,房间号已经存在
1001 房间内操作时,房间 configId 不存在,或者 configId 对应的 config 不存在
1002 加入房间时,角色数量超限
1003 指定角色未定义
1004 找不到房间
1005 config 不存在或无法使用
1006 房间属性已经存在
1007 成员属性已经存在
1015 被操作的成员不存在
1017 创建房间时房间已经存在且 config 冲突