Class VoiceGroup

Type-safe version of EventEmitter

Hierarchy (view full)

Constructors

constructor

Properties

isUserMuteMicrophone isUserMuteSpeaker isUserMuted topics userAuth?

Accessors

currentGroupId

Methods

createGroup destroyGroup dispose getGroupPubUsers getGroupStatus getGroupUserList joinGroup kickUser muteMicrophone muteSpeaker muteUser off on once quitGroup transferRole unmuteMicrophone unmuteSpeaker unmuteUser

Constructors

constructor

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

Methods

createGroup

  • createGroup(type, groupId?, extInfo?): Promise<void>

  • 创建房间（不推荐使用，在非管理端会出现很多时序问题）

    Parameters

    • type: EFolloweType

      // TODO: 待明确

    • Optional groupId: string

      选填，会议 Id,选填 会议 Id，如果不填则默认当前已经进入的房间

    • extInfo: string = ''

      选填，额外信息，不填为空字符串

    Returns Promise<void>

destroyGroup

  • destroyGroup(groupId?): Promise<void>

  • 销毁房间

    Parameters

    • Optional groupId: string

      选填 会议 Id，如果不填则默认当前已经进入的房间

    Returns Promise<void>

dispose

  • dispose(): void

  • 移除所有的监听事件

    Returns void

getGroupPubUsers

  • getGroupPubUsers(groupId): Promise<IVoiceGroupUserInfo[]>

  • 获取群组中可说话的用户列表

    Parameters

    • groupId: string

      群组 Id

    Returns Promise<IVoiceGroupUserInfo[]>

getGroupStatus

  • getGroupStatus(groupId): Promise<EGroupStatus>

  • 获取群组的状态（开启、关闭、被销毁、不存在等）

    Parameters

    • groupId: string

      群组 Id

    Returns Promise<EGroupStatus>

getGroupUserList

  • getGroupUserList(groupId): Promise<IVoiceGroupUserInfo[]>

  • 获取群组中的用户列表

    Parameters

    • groupId: string

      群组 Id

    Returns Promise<IVoiceGroupUserInfo[]>

joinGroup

  • joinGroup(groupId, isPublish?): Promise<void>

  • 加入群组

    Parameters

    • groupId: string

      群组 Id

    • isPublish: boolean = true

      是否语音加入，权限调通后自动授权

    Returns Promise<void>

kickUser

  • kickUser(targetUserId, groupId?): Promise<void>

  • 将用户踢出房间

    Parameters

    • targetUserId: string

      要踢出的用户 Id

    • Optional groupId: string

      可选 要在哪个会议室踢出用户

    Returns Promise<void>

muteMicrophone

  • muteMicrophone(): void

  • 关闭麦克风

    Returns void

muteSpeaker

  • muteSpeaker(): void

  • 静音扬声器

    Returns void

muteUser

  • muteUser(targetUserId, groupId?): Promise<void>

  • 将用户静音

    Parameters

    • targetUserId: string

      要踢出的用户 Id

    • Optional groupId: string

      可选 要在哪个会议室踢出用户

    Returns Promise<void>

off

  • off<K>(topic, listener?): void

  • 移除监听事件

    Type Parameters

    • K extends keyof IVoiceGroupEventMap

    Parameters

    • topic: K
    • Optional listener: IListener<IVoiceGroupEventMap[K]>

    Returns void

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

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

quitGroup

  • quitGroup(): Promise<void>

  • 退出群组

    Returns Promise<void>

transferRole

  • transferRole(userId, groupId?): Promise<void>

  • Parameters

    • userId: string
    • Optional groupId: string

    Returns Promise<void>

unmuteMicrophone

  • unmuteMicrophone(): void

  • 开启麦克风

    Returns void

unmuteSpeaker

  • unmuteSpeaker(): void

  • 开启扬声器

    Returns void

unmuteUser

  • unmuteUser(targetUserId, groupId?): Promise<void>

  • 解除用户静音

    Parameters

    • targetUserId: string

      要踢出的用户 Id

    • Optional groupId: string

      可选 要在哪个会议室踢出用户

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc