Class RTCExample

RTCExample。

Hierarchy

Subscribe<RTCEventType>
- RTCExample

Implements

RTCProtocol

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RTCExample(): RTCExample

Inherited from Subscribe.constructor
Returns RTCExample

Properties

joined

joined: boolean = false

micro

micro: boolean = false

type

type: RTCType = RTCType.realsee

voiceId

voiceId: string = ''

Methods

detectMicro

detectMicro(): Promise<boolean>

Implementation of RTCProtocol.detectMicro
- Defined in RTC/index.ts:22
监测麦克风授权。

Returns Promise<boolean>

emit

emit<K>(name: K, ...data: Parameters<RTCEventType[K]>): boolean

Implementation of RTCProtocol.emit
Inherited from Subscribe.emit
- Defined in shared-utils/Subscribe.ts:127
触发事件

Type parameters
- K: keyof RTCEventType
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- Rest ...data: Parameters<RTCEventType[K]>
  
  触发事件的数据
Returns boolean
canceled 是否被触发取消

hasListener

hasListener(name: keyof RTCEventType): boolean

Implementation of RTCProtocol.hasListener
Inherited from Subscribe.hasListener
- Defined in shared-utils/Subscribe.ts:48
判断是否注册了事件

Parameters
- name: keyof RTCEventType
  
  事件类型
Returns boolean

join

join(options: { roomId: string | number; type: RTCType; userId: string; voiceId: string }): Promise<boolean>

Implementation of RTCProtocol.join
- Defined in RTC/index.ts:10
加入房间。

Parameters
- options: { roomId: string | number; type: RTCType; userId: string; voiceId: string }
  - roomId: string | number
  - type: RTCType
  - userId: string
  - voiceId: string
Returns Promise<boolean>

off

off<K>(name?: K, callback?: (...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>): void

Implementation of RTCProtocol.off
Inherited from Subscribe.off
- Defined in shared-utils/Subscribe.ts:97
解除事件

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

Type parameters
- K: keyof RTCEventType
  
  预设的监听事件名称
Parameters
- Optional name: K
  
  事件类型
- Optional callback: (...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>
  
  事件回调函数
  - - (...args: Parameters<RTCEventType[K]>): ReturnType<RTCEventType[K]>
    - Parameters
      - Rest ...args: Parameters<RTCEventType[K]>
      Returns ReturnType<RTCEventType[K]>
Returns void

on

on<K>(name: K, callback: (...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>, once?: boolean): () => void

Implementation of RTCProtocol.on
Inherited from Subscribe.on
- Defined in shared-utils/Subscribe.ts:62
注册事件

Type parameters
- K: keyof RTCEventType
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- callback: (...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>
  
  事件回调函数
  - - (...args: Parameters<RTCEventType[K]>): ReturnType<RTCEventType[K]>
    - Parameters
      - Rest ...args: Parameters<RTCEventType[K]>
      Returns ReturnType<RTCEventType[K]>
- Optional once: boolean
  
  是否只执行一次
Returns () => void
解除事件
- - (): void
  - 注册事件
    
    Returns void
    解除事件

once

once<K>(name: K, callback: (...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>): () => void

Implementation of RTCProtocol.once
Inherited from Subscribe.once
- Defined in shared-utils/Subscribe.ts:81
注册事件(是否只执行一次)

Type parameters
- K: keyof RTCEventType
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- callback: (...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>
  
  事件回调函数
  - - (...args: Parameters<RTCEventType[K]>): ReturnType<RTCEventType[K]>
    - Parameters
      - Rest ...args: Parameters<RTCEventType[K]>
      Returns ReturnType<RTCEventType[K]>
Returns () => void
解除事件
- - (): void
  - 注册事件(是否只执行一次)
    
    Returns void
    解除事件

quit

quit(): Promise<boolean>

Implementation of RTCProtocol.quit
- Defined in RTC/index.ts:19
离开房间。

Returns Promise<boolean>

shock

shock(): void

Implementation of RTCProtocol.shock
- Defined in RTC/index.ts:28
震动。

Returns void

toggleMicro

toggleMicro(flag?: boolean): Promise<boolean>

Implementation of RTCProtocol.toggleMicro
- Defined in RTC/index.ts:25
关闭\开启本地麦克风。

Parameters
- Optional flag: boolean
Returns Promise<boolean>