ClassCoreRTCAbstract

RTC 基础抽象类

所有 RTC 实现的基类，定义了 RTC 协议的基本接口。 子类需要实现所有抽象方法和属性。

Example

class MyRTC extends CoreRTC {
  joined = false
  micro = false
  voiceId = ''
  type = RTCType.Custom
  
  async join(options) {
    // 实现加入房间逻辑
  }
  
  async quit() {
    // 实现退出房间逻辑
  }
  
  // 实现其他抽象方法...
}

Hierarchy (view full)

Implements

Constructors

constructor

Properties

joined micro type voiceId

Methods

detectMicro emit hasListener join off on once quit shock toggleMicro

Constructors

constructor

Properties

Abstractjoined

joined: boolean

是否已加入语音房间

Abstractmicro

micro: boolean

麦克风是否开启

Abstracttype

type: RTCType

RTC 实现类型

AbstractvoiceId

voiceId: string

当前语音房间ID

Methods

AbstractdetectMicro

  • 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

Abstractjoin

  • 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

Abstractquit

  • quit(): Promise<boolean>

  • 退出语音房间

    Returns Promise<boolean>

    Promise 是否成功退出房间

Abstractshock

  • shock(): void

  • 震动（如果设备支持）

    Returns void

AbstracttoggleMicro

  • toggleMicro(flag?): Promise<boolean>

  • 切换麦克风状态

    Parameters

    • Optionalflag: boolean

      是否开启麦克风，不传则切换当前状态

    Returns Promise<boolean>

    Promise 是否操作成功

Settings

Member Visibility

On This Page

Constructors
Properties
Methods