-
- All Implemented Interfaces:
public interface NERoomContext
房间上下文
-
-
Method Summary
Modifier and Type Method Description abstract Boolean
isInWaitingRoom()
查询当前用户是否在等候室中 abstract NERoomMember
getMember(String uuid)
通过 uuid 获取成员对象 abstract Unit
addRoomListener(NERoomListener listener)
添加房间事件监听 abstract Unit
removeRoomListener(NERoomListener listener)
移除房间监听 abstract Unit
updateRoomProperty(String key, String value, String associatedUserUuid, NECallback<Unit> callback)
更新房间属性 abstract Unit
deleteRoomProperty(String key, NECallback<Unit> callback)
删除房间属性 abstract Unit
updateMemberProperty(String userUuid, String key, String value, NECallback<Unit> callback)
更新成员属性 abstract Unit
deleteMemberProperty(String userUuid, String key, NECallback<Unit> callback)
删除成员属性 abstract Unit
changeMemberRole(String userUuid, String role, NECallback<Unit> callback)
修改成员角色,自己的角色不会发生变化。 只有授权角色才能执行该操作。 abstract Unit
changeMembersRole(Map<String, String> userRoleMap, NECallback<Unit> callback)
批量修改房间内的成员角色。只有授权角色才能执行该操作。 abstract Unit
handOverMyRole(String userUuid, NECallback<Unit> callback)
将自身当前的角色转移给userUuid对应的用户,自身会恢复到默认的房间角色。 只有授权角色才能执行该操作。 abstract Unit
changeMyName(String name, NECallback<Unit> callback)
修改昵称 abstract Unit
changeMemberName(String userUuid, String name, NECallback<Unit> callback)
修改成员昵称 abstract Unit
changeMyExt(String ext, NECallback<Unit> callback)
修改我的扩展字段 abstract Unit
kickMemberOut(String userUuid, Boolean toBlacklist, NECallback<Unit> callback)
移除成员 abstract Unit
lockRoom(NECallback<Unit> callback)
锁定房间。锁定后成员无法加入 abstract Unit
unlockRoom(NECallback<Unit> callback)
解除锁定房间。解除锁定后成员可以加入该房间 abstract Unit
changeRoomName(String roomName, NECallback<Unit> callback)
修改房间名称 abstract Unit
changeRoomExt(String roomExt, NECallback<Unit> callback)
修改房间扩展信息 abstract Unit
leaveRoom(NECallback<Unit> callback)
离开房间 abstract Unit
endRoom(Boolean isForce, NECallback<Unit> callback)
关闭房间 abstract Unit
addRtcStatsListener(NERoomRtcStatsListener listener)
添加Rtc统计数据监听 abstract Unit
removeRtcStatsListener(NERoomRtcStatsListener listener)
移除Rtc统计数据监听 abstract Unit
rejoinAfterAdmittedToRoom(NECallback<Unit> callback)
用于在房间管理员授权成员加入后重新加入房间。 如等候室内的成员在被准入后可通过该接口重新加入当前房间。 abstract Unit
banRoomChat(String notifyExt, NECallback<Unit> callback)
设置房间所有成员禁用聊天功能 abstract Unit
unbanRoomChat(String notifyExt, NECallback<Unit> callback)
取消房间所有成员禁用聊天功能 abstract Unit
banRoomAudio(String notifyExt, NECallback<Unit> callback)
设置房间内所有成员音频 abstract Unit
banRoomVideo(String notifyExt, NECallback<Unit> callback)
设置房间内所有成员视频 abstract Unit
unbanRoomAudio(String notifyExt, NECallback<Unit> callback)
取消房间内所有成员音频禁言 abstract Unit
unbanRoomVideo(String notifyExt, NECallback<Unit> callback)
取消房间内所有成员视频禁言 abstract Unit
enableRoomBlacklist(Boolean enable, NECallback<Unit> callback)
开启黑名单 abstract Unit
addToBlacklist(String userUuid, String notifyExt, NECallback<Unit> callback)
拉黑成员 abstract Unit
removeFromBlacklist(String userUuid, String notifyExt, NECallback<Unit> callback)
取消拉黑成员 abstract Unit
getBlacklist(Integer pageNum, Integer pageSize, NECallback<List<NERoomBlacklistMember>> callback)
获取房间内黑名单列表 abstract Unit
startCloudRecord(NECallback<Unit> callback)
开始云录制 abstract Unit
stopCloudRecord(NECallback<Unit> callback)
结束云录制 abstract String
getRoomUuid()
房间id abstract String
getRoomName()
房间名称 abstract String
getRoomExt()
房间扩展信息 abstract String
getPassword()
房间密码 abstract Long
getRtcStartTime()
房间rtc开始时间, ms abstract String
getSipCid()
房间SIP号 abstract Long
getRemainingSeconds()
如果为负数(例如-1),则是房间不会结束。 remainingSeconds表示房间离结束还剩余的秒数,单位/s, abstract Boolean
getIsCloudRecording()
房间是否正在云录制 abstract Boolean
getIsRoomBlackListEnabled()
房间是否开启了黑名单 abstract Boolean
getIsAnnotationEnabled()
当前是否开启了批注 abstract NERoomMember
getLocalMember()
本端信息 abstract List<NERoomMember>
getRemoteMembers()
远端成员(不包括本端) abstract List<NERoomMember>
getInSIPInvitingMembers()
正在SIP外呼邀请中的成员列表 abstract List<NERoomMember>
getInAppInvitingMembers()
正在App外呼邀请中的成员列表 abstract NERoomChatController
getChatController()
聊天室控制器 abstract NERoomWhiteboardController
getWhiteboardController()
白板控制器 abstract NERoomAnnotationController
getAnnotationController()
批注白板控制器 abstract NERoomRtcController
getRtcController()
音视频控制器 abstract NERoomLiveController
getLiveController()
直播控制器 abstract NESeatController
getSeatController()
麦位控制器 abstract NEWaitingRoomController
getWaitingRoomController()
等候室控制器 abstract NERoomSIPController
getSipController()
SIP外呼控制器 abstract NERoomAppInviteController
getAppInviteController()
appInvite外呼控制器 abstract Integer
getMaxMembers()
房间最大人数, -1表示无限制 abstract Map<String, String>
getRoomProperties()
获取房间当前时间所有属性 abstract Boolean
getIsRoomLocked()
查询房间当前锁定状态 abstract Boolean
getIsRoomChatBanned()
查询房间聊天禁言状态 abstract Boolean
getIsRoomAudioBanned()
查询房间音频禁言状态 abstract Boolean
getIsRoomVideoBanned()
查询房间视频禁言状态 -
-
Method Detail
-
isInWaitingRoom
abstract Boolean isInWaitingRoom()
查询当前用户是否在等候室中
-
getMember
abstract NERoomMember getMember(String uuid)
通过 uuid 获取成员对象
-
addRoomListener
abstract Unit addRoomListener(NERoomListener listener)
添加房间事件监听
- Parameters:
listener
- 房间监听
-
removeRoomListener
abstract Unit removeRoomListener(NERoomListener listener)
移除房间监听
- Parameters:
listener
- 房间监听
-
updateRoomProperty
abstract Unit updateRoomProperty(String key, String value, String associatedUserUuid, NECallback<Unit> callback)
更新房间属性
- Parameters:
key
- 属性唯一keyvalue
- 属性值associatedUserUuid
- 声明该属性关联的用户uuid,如果该用户退出房间,该属性会被删除callback
- 回调
-
deleteRoomProperty
abstract Unit deleteRoomProperty(String key, NECallback<Unit> callback)
删除房间属性
- Parameters:
key
- 属性唯一keycallback
- 回调
-
updateMemberProperty
abstract Unit updateMemberProperty(String userUuid, String key, String value, NECallback<Unit> callback)
更新成员属性
- Parameters:
userUuid
- 成员uuidkey
- 属性唯一keyvalue
- 属性值callback
- 回调
-
deleteMemberProperty
abstract Unit deleteMemberProperty(String userUuid, String key, NECallback<Unit> callback)
删除成员属性
- Parameters:
userUuid
- 成员uuidkey
- 属性唯一keycallback
- 回调
-
changeMemberRole
abstract Unit changeMemberRole(String userUuid, String role, NECallback<Unit> callback)
修改成员角色,自己的角色不会发生变化。 只有授权角色才能执行该操作。
- Parameters:
userUuid
- 用户idrole
- 角色callback
- 回调
-
changeMembersRole
abstract Unit changeMembersRole(Map<String, String> userRoleMap, NECallback<Unit> callback)
批量修改房间内的成员角色。只有授权角色才能执行该操作。
- Parameters:
userRoleMap
- 成员账号与角色名称映射表callback
- 回调
-
handOverMyRole
abstract Unit handOverMyRole(String userUuid, NECallback<Unit> callback)
将自身当前的角色转移给userUuid对应的用户,自身会恢复到默认的房间角色。 只有授权角色才能执行该操作。
- Parameters:
userUuid
- 目标用户idcallback
- 回调
-
changeMyName
abstract Unit changeMyName(String name, NECallback<Unit> callback)
修改昵称
- Parameters:
name
- 昵称callback
- 回调
-
changeMemberName
abstract Unit changeMemberName(String userUuid, String name, NECallback<Unit> callback)
修改成员昵称
- Parameters:
userUuid
- 用户idname
- 昵称callback
- 回调
-
changeMyExt
abstract Unit changeMyExt(String ext, NECallback<Unit> callback)
修改我的扩展字段
- Parameters:
ext
- 扩展字段callback
- 回调
-
kickMemberOut
abstract Unit kickMemberOut(String userUuid, Boolean toBlacklist, NECallback<Unit> callback)
移除成员
- Parameters:
userUuid
- 用户idtoBlacklist
- 是否加入黑名单callback
- 回调
-
lockRoom
abstract Unit lockRoom(NECallback<Unit> callback)
锁定房间。锁定后成员无法加入
- Parameters:
callback
- 回调
-
unlockRoom
abstract Unit unlockRoom(NECallback<Unit> callback)
解除锁定房间。解除锁定后成员可以加入该房间
- Parameters:
callback
- 回调
-
changeRoomName
abstract Unit changeRoomName(String roomName, NECallback<Unit> callback)
修改房间名称
-
changeRoomExt
abstract Unit changeRoomExt(String roomExt, NECallback<Unit> callback)
修改房间扩展信息
-
leaveRoom
abstract Unit leaveRoom(NECallback<Unit> callback)
离开房间
- Parameters:
callback
- 回调
-
endRoom
abstract Unit endRoom(Boolean isForce, NECallback<Unit> callback)
关闭房间
- Parameters:
isForce
- 是否强制关闭callback
- 回调
-
addRtcStatsListener
abstract Unit addRtcStatsListener(NERoomRtcStatsListener listener)
添加Rtc统计数据监听
- Parameters:
listener
- 监听器
-
removeRtcStatsListener
abstract Unit removeRtcStatsListener(NERoomRtcStatsListener listener)
移除Rtc统计数据监听
- Parameters:
listener
- 监听器
-
rejoinAfterAdmittedToRoom
abstract Unit rejoinAfterAdmittedToRoom(NECallback<Unit> callback)
用于在房间管理员授权成员加入后重新加入房间。 如等候室内的成员在被准入后可通过该接口重新加入当前房间。
- Parameters:
callback
- 回调。如果加入失败或成员未被授权加入,则会回调失败。
-
banRoomChat
abstract Unit banRoomChat(String notifyExt, NECallback<Unit> callback)
设置房间所有成员禁用聊天功能
- Parameters:
notifyExt
- 扩展信息callback
- 回调 <br>相关回调:调用成功后,会立即触发NERoomListener.onRoomChatBanStateChanged回调
-
unbanRoomChat
abstract Unit unbanRoomChat(String notifyExt, NECallback<Unit> callback)
取消房间所有成员禁用聊天功能
- Parameters:
notifyExt
- 扩展信息callback
- 回调 <br>相关回调:调用成功后,会立即触发NERoomListener.onRoomChatBanStateChanged回调
-
banRoomAudio
abstract Unit banRoomAudio(String notifyExt, NECallback<Unit> callback)
设置房间内所有成员音频
- Parameters:
notifyExt
- 扩展信息callback
- 回调 <br>相关回调:禁用音频会立即触发NERoomListener.onRoomAudioBanStateChanged回调
-
banRoomVideo
abstract Unit banRoomVideo(String notifyExt, NECallback<Unit> callback)
设置房间内所有成员视频
- Parameters:
notifyExt
- 扩展信息callback
- 回调 <br>相关回调:禁用视频会立即触发NERoomListener.onRoomVideoBanStateChanged回调
-
unbanRoomAudio
abstract Unit unbanRoomAudio(String notifyExt, NECallback<Unit> callback)
取消房间内所有成员音频禁言
- Parameters:
notifyExt
- 扩展信息callback
- 回调 <br>相关回调:禁用音频会立即触发NERoomListener.onRoomAudioBanStateChanged回调
-
unbanRoomVideo
abstract Unit unbanRoomVideo(String notifyExt, NECallback<Unit> callback)
取消房间内所有成员视频禁言
- Parameters:
notifyExt
- 扩展信息callback
- 回调 <br>相关回调:禁用视频会立即触发NERoomListener.onRoomVideoBanStateChanged回调
-
enableRoomBlacklist
abstract Unit enableRoomBlacklist(Boolean enable, NECallback<Unit> callback)
开启黑名单
- Parameters:
enable
- 是否开启callback
- 回调
-
addToBlacklist
abstract Unit addToBlacklist(String userUuid, String notifyExt, NECallback<Unit> callback)
拉黑成员
- Parameters:
userUuid
- 用户idnotifyExt
- 扩展信息callback
- 回调 <br>相关回调:调用成功后,会立即触发NERoomListener.onMemberAddToBlacklist回调
-
removeFromBlacklist
abstract Unit removeFromBlacklist(String userUuid, String notifyExt, NECallback<Unit> callback)
取消拉黑成员
- Parameters:
userUuid
- 用户idnotifyExt
- 扩展信息callback
- 回调 <br>相关回调:调用成功后,会立即触发NERoomListener.onMemberRemoveFromBlacklist回调
-
getBlacklist
abstract Unit getBlacklist(Integer pageNum, Integer pageSize, NECallback<List<NERoomBlacklistMember>> callback)
获取房间内黑名单列表
- Parameters:
pageNum
- 页数pageSize
- 一页多少条callback
- 回调
-
startCloudRecord
abstract Unit startCloudRecord(NECallback<Unit> callback)
开始云录制
- Parameters:
callback
- 回调
-
stopCloudRecord
abstract Unit stopCloudRecord(NECallback<Unit> callback)
结束云录制
- Parameters:
callback
- 回调
-
getRoomUuid
abstract String getRoomUuid()
房间id
-
getRoomName
abstract String getRoomName()
房间名称
-
getRoomExt
abstract String getRoomExt()
房间扩展信息
-
getPassword
abstract String getPassword()
房间密码
-
getRtcStartTime
abstract Long getRtcStartTime()
房间rtc开始时间, ms
-
getRemainingSeconds
abstract Long getRemainingSeconds()
如果为负数(例如-1),则是房间不会结束。 remainingSeconds表示房间离结束还剩余的秒数,单位/s,
-
getIsCloudRecording
abstract Boolean getIsCloudRecording()
房间是否正在云录制
-
getIsRoomBlackListEnabled
abstract Boolean getIsRoomBlackListEnabled()
房间是否开启了黑名单
-
getIsAnnotationEnabled
abstract Boolean getIsAnnotationEnabled()
当前是否开启了批注
-
getLocalMember
abstract NERoomMember getLocalMember()
本端信息
-
getRemoteMembers
abstract List<NERoomMember> getRemoteMembers()
远端成员(不包括本端)
-
getInSIPInvitingMembers
abstract List<NERoomMember> getInSIPInvitingMembers()
正在SIP外呼邀请中的成员列表
-
getInAppInvitingMembers
abstract List<NERoomMember> getInAppInvitingMembers()
正在App外呼邀请中的成员列表
-
getChatController
abstract NERoomChatController getChatController()
聊天室控制器
-
getWhiteboardController
abstract NERoomWhiteboardController getWhiteboardController()
白板控制器
-
getAnnotationController
abstract NERoomAnnotationController getAnnotationController()
批注白板控制器
-
getRtcController
abstract NERoomRtcController getRtcController()
音视频控制器
-
getLiveController
abstract NERoomLiveController getLiveController()
直播控制器
-
getSeatController
abstract NESeatController getSeatController()
麦位控制器
-
getWaitingRoomController
abstract NEWaitingRoomController getWaitingRoomController()
等候室控制器
-
getSipController
abstract NERoomSIPController getSipController()
SIP外呼控制器
-
getAppInviteController
abstract NERoomAppInviteController getAppInviteController()
appInvite外呼控制器
-
getMaxMembers
abstract Integer getMaxMembers()
房间最大人数, -1表示无限制
-
getRoomProperties
abstract Map<String, String> getRoomProperties()
获取房间当前时间所有属性
-
getIsRoomLocked
abstract Boolean getIsRoomLocked()
查询房间当前锁定状态
-
getIsRoomChatBanned
abstract Boolean getIsRoomChatBanned()
查询房间聊天禁言状态
-
getIsRoomAudioBanned
abstract Boolean getIsRoomAudioBanned()
查询房间音频禁言状态
-
getIsRoomVideoBanned
abstract Boolean getIsRoomVideoBanned()
查询房间视频禁言状态
-
-
-
-