NERoomContext class abstract

当前房间的上下文

Mixed in types

• AttachmentMixin

Annotations

• @HawkEntryPoint()

Constructors

NERoomContext()

Properties

chatController → NERoomChatController

获取聊天控制器

no setter

hashCode → int

The hash code for this object.

no setter, inherited

isCloudRecording → bool

查询房间云录制状态

no setter

isRoomBlackListEnabled → bool

查询房间是否开启黑名单

no setter

isRoomLocked → bool

查询房间当前锁定状态

no setter

liveController → NERoomLiveController

获取直播控制器

no setter

localMember → NERoomMember

本端成员

no setter

password → String?

房间密码

no setter

remainingSeconds → int

查询房间当前剩余时间

no setter

remoteMembers → List<NERoomMember>

远端成员（不包括本端）

no setter

roomName → String

房间成员

no setter

roomProperties → Map<String, String>

获取当前房间属性

no setter

roomUuid → String

房间唯一标识

no setter

rtcController → NERoomRtcController

获取rtc控制器

no setter

rtcStartTime → int

房间 rtc 开始时间, 单位ms

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

seatController → NERoomSeatController

麦位控制器

no setter

sipCid → String?

查询房间当前锁定状态

no setter

waitingRoomController → NEWaitingRoomController

等候室控制器

no setter

whiteboardController → NERoomWhiteboardController

获取白板控制器

no setter

Methods

addAttachment(Object key, dynamic attachment) → void

inherited

addEventCallback(NERoomEventCallback callback) → void

添加房间事件监听

addRtcStatsCallback(NERoomRtcStatsCallback callback) → void

添加统计数据监听

changeMemberName(String userUuid, String name) → Future<VoidResult>

修改成员昵称

changeMemberRole(String userUuid, String role) → Future<VoidResult>

修改成员角色

changeMembersRole(Map<String, String> userRoleMap) → Future<VoidResult>

批量修改房间内的成员角色。只有授权角色才能执行该操作。 userRoleMap 成员账号与角色名称映射表

changeMyName(String name) → Future<VoidResult>

修改昵称

clearAttachments() → void

inherited

deleteMemberProperty(String userUuid, String key) → Future<VoidResult>

删除房间成员属性

deleteRoomProperty(String key) → Future<VoidResult>

删除房间属性

enableRoomBlacklist(bool enable) → Future<VoidResult>

endRoom([bool isForce = false]) → Future<VoidResult>

关闭房间

ensureAttachment<T>(Object key) → T

inherited

getAttachment<T>(Object key) → T?

inherited

getMember(String? uuid) → NERoomMember?

通过 uuid 获取成员对象

handOverMyRole(String userUuid) → Future<VoidResult>

将自身当前的角色转移给userUuid对应的用户，自身会恢复到默认的房间角色。 只有授权角色才能执行该操作。

isInWaitingRoom() → bool

查询本端成员是否在等候室中

kickMemberOut(String userUuid, bool toBlacklist) → Future<VoidResult>

移除成员 userUuid 用户id toBlacklist 是否加入黑名单

leaveRoom() → Future<VoidResult>

离开房间

lockRoom() → Future<VoidResult>

锁定房间。锁定后成员无法加入

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

rejoinAfterAdmittedToRoom() → Future<VoidResult>

用于在房间管理员授权成员加入后重新加入房间。 如等候室内的成员在被准入后可通过该接口重新加入当前房间。如果加入失败或成员未被授权加入，则会回调失败。

removeAttachment(Object key) → void

inherited

removeEventCallback(NERoomEventCallback callback) → void

移除房间事件监听

removeRtcStatsCallback(NERoomRtcStatsCallback callback) → void

删除统计数据监听

startCloudRecord() → Future<VoidResult>

开启云录制

stopCloudRecord() → Future<VoidResult>

结束云录制

toJson() → Map

toString() → String

A string representation of this object.

inherited

unlockRoom() → Future<VoidResult>

解除锁定房间。解除锁定后成员可以加入该房间

updateMemberProperty(String userUuid, String key, String value) → Future<VoidResult>

更新房间成员属性

updateRoomProperty(String key, String value, {String? associatedUuid}) → Future<VoidResult>

更新房间属性

Operators

operator ==(Object other) → bool

The equality operator.

inherited