InterfaceRTCProtocol

rtc 协议接口

interface RTCProtocol {
    joined: boolean;
    micro: boolean;
    type: RTCType;
    voiceId: string;
    checkRequirement?(): Promise<CheckResult>;
    detectMicro(): Promise<boolean>;
    emit<K>(name: K, ...data: Parameters<RTCEventType[K]>): boolean;
    hasListener(name: keyof RTCEventType): boolean;
    join(options: {
        roomId: undefined | string | number;
        type: RTCType;
        userId: string;
        voiceId: string;
    }): Promise<boolean>;
    off<K>(name?: K, callback?: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>)): void;
    on<K>(name: K, callback: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>), once?: boolean): (() => void);
    once<K>(name: K, callback: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>)): (() => void);
    quit(): Promise<boolean>;
    reJoin?(): Promise<boolean>;
    shock?(): void;
    toggleMicro(flag?: boolean): Promise<boolean>;
}

Hierarchy (view full)

Implemented by

Properties

joined micro type voiceId

Methods

checkRequirement? detectMicro emit hasListener join off on once quit reJoin? shock? toggleMicro

Properties

joined

joined: boolean

是否已经加入房间

micro

micro: boolean

麦克风状态

type

type: RTCType

rtc 实现类型

voiceId

voiceId: string

语音房间ID

Methods

OptionalcheckRequirement

  • checkRequirement(): Promise<CheckResult>

  • 检查rtc的系统依赖是否满足

    Returns Promise<CheckResult>

    返回一个Promise，表示检查结果

detectMicro

  • detectMicro(): Promise<boolean>

  • 监测麦克风授权。

    Returns Promise<boolean>

    返回一个Promise，表示麦克风是否被授权

emit

  • emit<K>(name, ...data): boolean

  • 触发事件

    Type Parameters

    Parameters

    • name: K

      事件类型

    • Rest...data: Parameters<RTCEventType[K]>

      触发事件的数据

    Returns boolean

    canceled 是否被触发取消

hasListener

  • hasListener(name): boolean

  • 判断是否注册了事件

    Parameters

    Returns boolean

join

  • join(options): Promise<boolean>

  • 加入房间。

    Parameters

    • options: {
          roomId: undefined | string | number;
          type: RTCType;
          userId: string;
          voiceId: string;
      }

      加入房间的选项

      • roomId: undefined | string | number

        房间ID

      • type: RTCType

        RTC类型

      • userId: string

        用户ID

      • voiceId: string

        语音房间ID

    Returns Promise<boolean>

    返回一个Promise，表示是否成功加入房间

off

  • off<K>(name?, callback?): void

  • 解除事件

    如果 name 不传的话解除对应所有事件 如果 name, callback 不传的话解除所有name的所有事件

    Type Parameters

    Parameters

    Returns void

on

  • on<K>(name, callback, once?): (() => void)

  • 注册事件

    Type Parameters

    Parameters

    Returns (() => void)

    解除事件

      • (): void

      • Returns void

once

  • once<K>(name, callback): (() => void)

  • 注册事件(是否只执行一次)

    Type Parameters

    Parameters

    Returns (() => void)

    解除事件

      • (): void

      • Returns void

quit

  • quit(): Promise<boolean>

  • 离开房间。

    Returns Promise<boolean>

    返回一个Promise，表示是否成功离开房间

OptionalreJoin

  • reJoin(): Promise<boolean>

  • 重新加入房间。

    Returns Promise<boolean>

    返回一个Promise，表示是否成功重新加入房间

Optionalshock

  • shock(): void

  • 震动。

    Returns void

toggleMicro

  • toggleMicro(flag?): Promise<boolean>

  • 关闭\开启 本地麦克风。

    Parameters

    • Optionalflag: boolean

      是否开启麦克风，默认为切换当前状态

    Returns Promise<boolean>

    返回一个Promise，表示操作是否成功

Settings

Member Visibility

On This Page

Properties
Methods