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