Class VoiceGroupV2

Type-safe version of EventEmitter

Hierarchy (view full)

EventEmitter<IVoiceGroupEventMap>
- VoiceGroupV2

Constructors

constructor

new VoiceGroupV2(world): VoiceGroupV2
对外暴露的当前用户状态
Parameters
- world: World
Returns VoiceGroupV2
Overrides EventEmitter.constructor
- Defined in packages/core/src/voice-group-v2/voice-group.ts:169

Properties

isUserMuteMicrophone

isUserMuteMicrophone: boolean = false

本机用户是否关闭了麦克风

isUserMuteSpeaker

isUserMuteSpeaker: boolean = false

本机用户是否关闭了扬声器

isUserMuted

isUserMuted: boolean = false

本机用户是否被禁言

topics

topics: Record<keyof IVoiceGroupEventMap, ITopic<any>[]> = ...

`Optional` userAuth

userAuth?: Listener | SpecialGuest | Hoster = undefined

本机用户在当前房间的权限

Accessors

currentGroupId

get currentGroupId(): undefined | string
当前的会议 ID，只能 get，不能 set

Returns undefined | string
- Defined in packages/core/src/voice-group-v2/voice-group.ts:151

currentVoiceDomain

get currentVoiceDomain(): undefined | string
Returns undefined | string
- Defined in packages/core/src/voice-group-v2/voice-group.ts:155

Methods

applyJoinPrivateChat

applyJoinPrivateChat(userId, tarGetUserId, groupId): Promise<ICommonRes>
V2接口邀请用户加入私聊会议
Parameters
- userId: string
- tarGetUserId: string
  邀请者的ID
- groupId: string
Returns Promise<ICommonRes>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:1045

applyScreenShare

applyScreenShare(userId, groupId): Promise<ICommonRes>
V2接口用户申请投屏
Parameters
- userId: string
- groupId: string
Returns Promise<ICommonRes>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:985

applyTalk

applyTalk(userId, groupId): Promise<ICommonRes>
V2接口用户申请开麦
Parameters
- userId: string
- groupId: string
Returns Promise<ICommonRes>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:931

approvalJoinPrivateChat

approvalJoinPrivateChat(targetId, passAppliction, groupId, operatorUserId?): Promise<ICommonRes>
V2接口审批是否接受邀请，加入私聊会议
Parameters
- targetId: string
  审批对象 userId
- passAppliction: boolean
  是否通过
- groupId: string
- Optional operatorUserId: string
Returns Promise<ICommonRes>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:1069

approvalUserScreenShare

approvalUserScreenShare(targetId, passAppliction, groupId, operatorUserId?): Promise<ICommonRes>
V2接口审批用户投屏
Parameters
- targetId: string
  审批对象 userId
- passAppliction: boolean
  是否通过
- groupId: string
- Optional operatorUserId: string
Returns Promise<ICommonRes>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:1009

approvalUserTalk

approvalUserTalk(targetId, passAppliction, groupId, operatorUserId?): Promise<ICommonRes>
V2接口审批用户开麦
Parameters
- targetId: string
  审批对象 userId
- passAppliction: boolean
  是否通过
- groupId: string
- Optional operatorUserId: string
Returns Promise<ICommonRes>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:955

checkCreateGroupAuth

checkCreateGroupAuth(userID): Promise<boolean>
V2接口
Parameters
- userID: string
Returns Promise<boolean>
boolean

Description
检测用户是否拥有创建群组的权限
- Defined in packages/core/src/voice-group-v2/voice-group.ts:1352

createGroup

createGroup(type?, groupType, extInfo?, numLimit?, groupId?): Promise<void>
创建房间（不推荐使用，在非管理端会出现很多时序问题）
Parameters
- type: EFolloweTypeV2 = EFolloweTypeV2.FT_AutoSub
  目前不用管，默认为1， FT_AutoSub
- groupType: EGroupTypeV2
  创建组的类型
- extInfo: string = ''
  选填，额外信息，不填为空字符串
- Optional numLimit: number
  人数限制, 不传为不限制
- Optional groupId: string
  选填，会议 Id,选填会议 Id，如果不填则默认当前已经进入的房间
Returns Promise<void>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:1266

destroyGroup

destroyGroup(groupId?): Promise<void>
销毁房间
Parameters
- Optional groupId: string
  选填会议 Id，如果不填则默认当前已经进入的房间
Returns Promise<void>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:1311

dispose

dispose(): void
移除所有的监听事件

Returns void
Inherited from EventEmitter.dispose
- Defined in packages/core/src/misc/emitter.ts:142

getGroupPubUsers

getGroupPubUsers(groupId): Promise<IVoiceGroupUserInfoV2[]>
V2接口获取群组中可说话的用户列表
Parameters
- groupId: string
  群组 Id
Returns Promise<IVoiceGroupUserInfoV2[]>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:624

getGroupStatus

getGroupStatus(groupId): Promise<EGroupStatusV2>
获取群组的状态（开启、关闭、被销毁、不存在等）
Parameters
- groupId: string
  群组 Id
Returns Promise<EGroupStatusV2>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:594

getGroupUserList

getGroupUserList(groupId): Promise<IVoiceGroupUserInfoV2[]>
V2接口获取群组中的用户列表
Parameters
- groupId: string
  群组 Id
Returns Promise<IVoiceGroupUserInfoV2[]>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:646

handleApplyScreenShareReceived

handleApplyScreenShareReceived(backendBusinessMsg): void
用户投屏申请 event emit
Parameters
- backendBusinessMsg: IBackendBusinessMsg
Returns void
- Defined in packages/core/src/voice-group-v2/voice-group.ts:288

handleApplyTalkReceived

handleApplyTalkReceived(backendBusinessMsg): void
用户开麦申请 event emit
Parameters
- backendBusinessMsg: IBackendBusinessMsg
Returns void
- Defined in packages/core/src/voice-group-v2/voice-group.ts:248

handleApprovalScreenShareResult

handleApprovalScreenShareResult(backendBusinessMsg): void
用户投屏审批结果
Parameters
- backendBusinessMsg: IBackendBusinessMsg
Returns void
- Defined in packages/core/src/voice-group-v2/voice-group.ts:300

handleApprovalTalkResult

handleApprovalTalkResult(backendBusinessMsg): void
用户开麦审批结果
Parameters
- backendBusinessMsg: IBackendBusinessMsg
Returns void
- Defined in packages/core/src/voice-group-v2/voice-group.ts:260

handleBeInvitedGuset

handleBeInvitedGuset(backendBusinessMsg): void
被邀请成为嘉宾
Parameters
- backendBusinessMsg: IBackendBusinessMsg
Returns void
- Defined in packages/core/src/voice-group-v2/voice-group.ts:312

handleBeKicked

handleBeKicked(backendBusinessMsg): void
被主持人踢出
Parameters
- backendBusinessMsg: IBackendBusinessMsg
Returns void
- Defined in packages/core/src/voice-group-v2/voice-group.ts:278

handleBeMuted

handleBeMuted(backendBusinessMsg): void
被主持人静音
Parameters
- backendBusinessMsg: IBackendBusinessMsg
Returns void
- Defined in packages/core/src/voice-group-v2/voice-group.ts:272

handleBeStopedScreenShare

handleBeStopedScreenShare(backendBusinessMsg): void
被主持人停止投屏
Parameters
- backendBusinessMsg: IBackendBusinessMsg
Returns void
- Defined in packages/core/src/voice-group-v2/voice-group.ts:283

handleInviteGuestResult

handleInviteGuestResult(backendBusinessMsg): void
邀请嘉宾结果
Parameters
- backendBusinessMsg: IBackendBusinessMsg
Returns void
- Defined in packages/core/src/voice-group-v2/voice-group.ts:317

handleUpdateScreenInfo

handleUpdateScreenInfo(backendBusinessMsg): void
投屏信息更新
Parameters
- backendBusinessMsg: IBackendBusinessMsg
Returns void
- Defined in packages/core/src/voice-group-v2/voice-group.ts:322

inviteGuestApproval

inviteGuestApproval(userID, isApproval, groupId?): Promise<void>
V2接口主持人邀请某人为嘉宾，被邀请者是否通过
Parameters
- userID: string
  受邀人ID
- isApproval: boolean
  是否同意
- Optional groupId: string
  可选，指定是在那个group发生的，一般不用填
Returns Promise<void>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:1143

joinGroup

joinGroup(groupId): Promise<void>
V2接口加入群组
Parameters
- groupId: string
  群组 Id
Returns Promise<void>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:464

kickUser

kickUser(targetUserId, groupId?): Promise<void>
将用户踢出房间
Parameters
- targetUserId: string
  要踢出的用户 Id
- Optional groupId: string
  可选要在哪个会议室踢出用户
Returns Promise<void>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:732

muteBatchUsers

muteBatchUsers(targetUserIds, groupId?, operatorUser?): Promise<void>
V2接口批量将用户静音
Parameters
- targetUserIds: string[]
- Optional groupId: string
  可选要在哪个会议室静音用户
- Optional operatorUser: string
Returns Promise<void>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:814

muteMicSelf

muteMicSelf(groupId): Promise<AxiosResponse<IPublishGroupRes, any>>
V2接口给自己闭麦（已授权后）
Parameters
- groupId: string
  语音组id
Returns Promise<AxiosResponse<IPublishGroupRes, any>>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:698

muteSpeaker

muteSpeaker(): void
静音扬声器

Returns void
- Defined in packages/core/src/voice-group-v2/voice-group.ts:421

muteUser

muteUser(targetUserId, groupId?): Promise<void>
V2接口将用户静音
Parameters
- targetUserId: string
  要静音的用户 Id
- Optional groupId: string
  可选要在哪个会议室静音用户
Returns Promise<void>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:775

off

off<K>(topic, listener?): void
移除监听事件
Type Parameters
- K extends keyof IVoiceGroupEventMap
Parameters
- topic: K
- Optional listener: IListener<IVoiceGroupEventMap[K]>
Returns void
Inherited from EventEmitter.off
- Defined in packages/core/src/misc/emitter.ts:84

on

on<K>(topic, listener, order?): {
unsub: (() => void);
}
添加事件监听器
Type Parameters
- K extends keyof IVoiceGroupEventMap
Parameters
- topic: K
- listener: IListener<IVoiceGroupEventMap[K]>
- Optional order: number
Returns {
unsub: (() => void);
}
- unsub: (() => void)
  - - (): void
    - Returns void
Inherited from EventEmitter.on
- Defined in packages/core/src/misc/emitter.ts:35

once

once<K>(topic, listener, order?): {
unsub: (() => void);
}
添加事件监听器，单个 listener 只执行1次
Type Parameters
- K extends keyof IVoiceGroupEventMap
Parameters
- topic: K
- listener: IListener<IVoiceGroupEventMap[K]>
- Optional order: number
Returns {
unsub: (() => void);
}
- unsub: (() => void)
  - - (): void
    - Returns void
Inherited from EventEmitter.once
- Defined in packages/core/src/misc/emitter.ts:46

openMicSelf

openMicSelf(groupId): Promise<AxiosResponse<IPublishGroupRes, any>>
V2接口给自己开麦（已授权后）
Parameters
- groupId: string
  语音组id
Returns Promise<AxiosResponse<IPublishGroupRes, any>>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:667

quitGroup

quitGroup(): Promise<void>
V2接口退出群组

Returns Promise<void>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:560

setRole

setRole(userId, roleType, groupId?): Promise<void>
给予用户身份，V2接口
Parameters
- userId: string
- roleType: ERoleTypeV2
  角色类型 ERoleTypeV2
- Optional groupId: string
Returns Promise<void>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:1102

setVoiceGroupDomain

setVoiceGroupDomain(voiceDomain): void
设置 voiceGroup 的后台请求地址
Parameters
- voiceDomain: string
  voiceGroup 的后台请求地址
Returns void
- Defined in packages/core/src/voice-group-v2/voice-group.ts:191

stopUserDeliverScreen

stopUserDeliverScreen(targertId, deliverScreenInfo, groupId?): Promise<void>
V2接口主持人停止用户投屏
Parameters
- targertId: string
- deliverScreenInfo: string
  初始投屏Info
- Optional groupId: string
Returns Promise<void>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:1181

unmuteBatchUsers

unmuteBatchUsers(targetUserIds, groupId?, operatorUserId?): Promise<void>
V2接口批量解除用户静音,且赋予自由开麦权限
Parameters
- targetUserIds: string[]
  要解除静音的用户 Id 组
- Optional groupId: string
  可选要在哪个会议室解除静音用户
- Optional operatorUserId: string
Returns Promise<void>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:854

unmuteSpeaker

unmuteSpeaker(): void
开启扬声器

Returns void
- Defined in packages/core/src/voice-group-v2/voice-group.ts:431

unmuteUser

unmuteUser(targetUserId, groupId?, operatorUserId?): Promise<void>
V2接口解除用户静音,且赋予自由开麦权限
Parameters
- targetUserId: string
  要解除静音的用户 Id
- Optional groupId: string
  可选要在哪个会议室解除静音用户
- Optional operatorUserId: string
Returns Promise<void>
- Defined in packages/core/src/voice-group-v2/voice-group.ts:892

Class VoiceGroupV2

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

world: World

Returns VoiceGroupV2

Properties

isUserMuteMicrophone

isUserMuteSpeaker

isUserMuted

topics

Optional userAuth

Accessors

currentGroupId

Returns undefined | string

currentVoiceDomain

Returns undefined | string

Methods

applyJoinPrivateChat

Parameters

userId: string

tarGetUserId: string

groupId: string

Returns Promise<ICommonRes>

applyScreenShare

Parameters

userId: string

groupId: string

Returns Promise<ICommonRes>

applyTalk

Parameters

userId: string

groupId: string

Returns Promise<ICommonRes>

approvalJoinPrivateChat

Parameters

targetId: string

passAppliction: boolean

groupId: string

Optional operatorUserId: string

Returns Promise<ICommonRes>

approvalUserScreenShare

Parameters

targetId: string

passAppliction: boolean

groupId: string

Optional operatorUserId: string

Returns Promise<ICommonRes>

approvalUserTalk

Parameters

targetId: string

passAppliction: boolean

groupId: string

Optional operatorUserId: string

Returns Promise<ICommonRes>

checkCreateGroupAuth

Parameters

userID: string

Returns Promise<boolean>

Description

createGroup

Parameters

type: EFolloweTypeV2 = EFolloweTypeV2.FT_AutoSub

groupType: EGroupTypeV2

extInfo: string = ''

Optional numLimit: number

Optional groupId: string

Returns Promise<void>

destroyGroup

Parameters

Optional groupId: string

Returns Promise<void>

dispose

Returns void

`Optional` userAuth

`Optional` operatorUserId: string

`Optional` operatorUserId: string

`Optional` operatorUserId: string

`Optional` numLimit: number

`Optional` groupId: string

`Optional` groupId: string

`Optional` groupId: string

`Optional` groupId: string