Interface NERoomContext

Hierarchy

  • NERoomContext

Properties

SIPController addRoomListener addRtcStatsListener annotationController? appInviteController changeMemberName changeMemberRole changeMembersRole changeMyName chatController? deleteMemberProperty deleteRoomProperty endRoom getMember handOverMyRole inAppInvitingMembers inSIPInvitingMembers isCloudRecording isInSIPInviting isInWaitingRoom isRoomBlacklistEnabled isRoomLocked kickMemberOut leaveRoom liveController localMember lockRoom maxMembers password? rejoinAfterAdmittedToRoom remainingSeconds remoteMembers removeRoomListener removeRtcStatsListener roomName roomProperties roomUuid rtcController? rtcStartTime sipCid? startCloudRecord stopCloudRecord unlockRoom updateMemberProperty updateRoomProperty waitingRoomController whiteboardController?

Methods

enableRoomBlacklist

Properties

SIPController

SIPController: NERoomSIPController

SIP邀请控制器

addRoomListener

addRoomListener: ((listener) => void)

Type declaration

    • (listener): void

    • 添加房间事件监听

      Parameters

      Returns void

addRtcStatsListener

addRtcStatsListener: ((listener) => void)

Type declaration

    • (listener): void

    • 添加Rtc统计数据监听

      Parameters

      Returns void

Optional annotationController

annotationController?: NERoomAnnotationController

批注白板控制器

appInviteController

appInviteController: NERoomInviteController

邀请控制器

changeMemberName

changeMemberName: ((userUuid, name) => Promise<NEResult<null>>)

Type declaration

    • (userUuid, name): Promise<NEResult<null>>

    • 修改成员昵称

      Parameters

      • userUuid: string

        用户id

      • name: string

        昵称

      Returns Promise<NEResult<null>>

changeMemberRole

changeMemberRole: ((userUuid, role) => Promise<NEResult<null>>)

Type declaration

    • (userUuid, role): Promise<NEResult<null>>

    • 修改成员角色，自己的角色不会发生变化。 只有授权角色才能执行该操作。

      Parameters

      • userUuid: string

        用户id

      • role: string

        角色

      Returns Promise<NEResult<null>>

changeMembersRole

changeMembersRole: ((userRoleMap) => Promise<NEResult<null>>)

Type declaration

    • (userRoleMap): Promise<NEResult<null>>

    • 批量修改房间内的成员角色。只有授权角色才能执行该操作。

      Parameters

      • userRoleMap: Record<string, string>

        用户id和角色的映射

      Returns Promise<NEResult<null>>

changeMyName

changeMyName: ((name) => Promise<NEResult<null>>)

Type declaration

    • (name): Promise<NEResult<null>>

    • 修改昵称

      Parameters

      • name: string

        昵称

      Returns Promise<NEResult<null>>

Optional chatController

chatController?: NERoomChatController

聊天室控制器

deleteMemberProperty

deleteMemberProperty: ((userUuid, key) => Promise<NEResult<null>>)

Type declaration

    • (userUuid, key): Promise<NEResult<null>>

    • 删除成员属性

      Parameters

      • userUuid: string

        成员uuid

      • key: string

        属性唯一key

      Returns Promise<NEResult<null>>

deleteRoomProperty

deleteRoomProperty: ((key) => Promise<NEResult<null>>)

Type declaration

    • (key): Promise<NEResult<null>>

    • 删除房间属性

      Parameters

      • key: string

        属性唯一key

      Returns Promise<NEResult<null>>

endRoom

endRoom: ((isForce?) => Promise<NEResult<null>>)

Type declaration

    • (isForce?): Promise<NEResult<null>>

    • 关闭房间

      Parameters

      • Optional isForce: boolean

        是否强制关闭

      Returns Promise<NEResult<null>>

getMember

getMember: ((uuid) => null | NERoomMember)

Type declaration

handOverMyRole

handOverMyRole: ((userUuid) => Promise<NEResult<null>>)

Type declaration

    • (userUuid): Promise<NEResult<null>>

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

      Parameters

      • userUuid: string

        目标用户id

      Returns Promise<NEResult<null>>

inAppInvitingMembers

inAppInvitingMembers: NERoomMember[]

获取应用内邀请中的成员

inSIPInvitingMembers

inSIPInvitingMembers: NERoomMember[]

获取正在SIP外呼邀请中的成员

isCloudRecording

isCloudRecording: boolean

当前是否正在云录制

isInSIPInviting

isInSIPInviting: boolean

是否SIP邀请入会

isInWaitingRoom

isInWaitingRoom: (() => boolean)

Type declaration

    • (): boolean

    • 查询当前用户是否在等候室中

      Returns boolean

isRoomBlacklistEnabled

isRoomBlacklistEnabled: boolean

房间是否开启了黑名单

isRoomLocked

isRoomLocked: boolean

查询房间当前锁定状态

kickMemberOut

kickMemberOut: ((userUuid, toBlacklist?) => Promise<NEResult<null>>)

Type declaration

    • (userUuid, toBlacklist?): Promise<NEResult<null>>

    • 移除成员

      Parameters

      • userUuid: string

        用户id

      • Optional toBlacklist: boolean

      Returns Promise<NEResult<null>>

leaveRoom

leaveRoom: (() => Promise<NEResult<null>>)

Type declaration

liveController

liveController: NERoomLiveController

直播控制器

localMember

localMember: NERoomMember

获取本端成员对象

lockRoom

lockRoom: (() => Promise<NEResult<null>>)

Type declaration

    • (): Promise<NEResult<null>>

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

      Returns Promise<NEResult<null>>

maxMembers

maxMembers: number

房间最大人数

Optional password

password?: string

房间密码

rejoinAfterAdmittedToRoom

rejoinAfterAdmittedToRoom: (() => Promise<NEResult<null>>)

Type declaration

    • (): Promise<NEResult<null>>

    • 用于在房间管理员授权成员加入后重新加入房间。 如等候室内的成员在被准入后可通过该接口重新加入当前房间。

      Returns Promise<NEResult<null>>

remainingSeconds

remainingSeconds: number

房间剩余时间

remoteMembers

remoteMembers: NERoomMember[]

获取远端成员列表（不包括本端）

removeRoomListener

removeRoomListener: ((listener) => void)

Type declaration

    • (listener): void

    • 移除房间监听

      Parameters

      Returns void

removeRtcStatsListener

removeRtcStatsListener: ((listener) => void)

Type declaration

    • (listener): void

    • 移除Rtc统计数据监听

      Parameters

      Returns void

roomName

roomName: string

房间名称

roomProperties

roomProperties: Record<string, unknown>

返回当前房间属性

roomUuid

roomUuid: string

房间id

Optional rtcController

rtcController?: NERoomRtcController

音视频控制器

rtcStartTime

rtcStartTime: number

房间rtc开始时间, ms

Optional sipCid

sipCid?: string

房间SIP号

startCloudRecord

startCloudRecord: (() => Promise<NEResult<null>>)

Type declaration

stopCloudRecord

stopCloudRecord: (() => Promise<NEResult<null>>)

Type declaration

unlockRoom

unlockRoom: (() => Promise<NEResult<null>>)

Type declaration

    • (): Promise<NEResult<null>>

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

      Returns Promise<NEResult<null>>

updateMemberProperty

updateMemberProperty: ((userUuid, key, value) => Promise<NEResult<null>>)

Type declaration

    • (userUuid, key, value): Promise<NEResult<null>>

    • 更新成员属性

      Parameters

      • userUuid: string

        成员uuid

      • key: string

        属性唯一key

      • value: string

        属性值

      Returns Promise<NEResult<null>>

updateRoomProperty

updateRoomProperty: ((key, value, associatedUserUuid?) => Promise<NEResult<null>>)

Type declaration

    • (key, value, associatedUserUuid?): Promise<NEResult<null>>

    • 更新房间属性

      Parameters

      • key: string

        属性唯一key

      • value: string

        属性值

      • Optional associatedUserUuid: string

        声明该属性关联的用户uuid，如果该用户退出房间，该属性会被删除

      Returns Promise<NEResult<null>>

waitingRoomController

waitingRoomController: NEWaitingRoomController

等候室控制器

Optional whiteboardController

whiteboardController?: NERoomWhiteboardController

白板控制器

Methods

enableRoomBlacklist

  • 开启黑名单

    Parameters

    • enable: boolean

      是否开启黑名单

    Returns Promise<NEResult<null>>

Settings

Member Visibility

Theme

On This Page