Interface RTCProtocol

rtc 协议接口

Hierarchy

Subscribe<RTCEventType>
- RTCProtocol

Implemented by

CoreRTC

Index

Properties

joined micro type voiceId

Methods

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

Properties

joined

joined: boolean

是否已经加入房间

micro

micro: boolean

麦克风状态

type

type: RTCType

rtc 实现类型

voiceId

voiceId: string

语音房间ID

Methods

`Optional` checkRequirement

checkRequirement(): Promise<CheckResult>
检查rtc的系统依赖是否满足

Returns Promise<CheckResult>
- Defined in typings/rtc/protocol.ts:34

detectMicro

detectMicro(): Promise<boolean>
监测麦克风授权。

Returns

Returns Promise<boolean>
- Defined in typings/rtc/protocol.ts:58

emit

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

Returns
canceled 是否被触发取消
Type Parameters
- K extends keyof RTCEventType
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- Rest ...data: Parameters<RTCEventType[K]>
  
  触发事件的数据
Returns boolean
Inherited from Subscribe.emit
- Defined in utils/subscribe.ts:122

hasListener

hasListener(name: keyof RTCEventType): boolean
判断是否注册了事件
Parameters
- name: keyof RTCEventType
  
  事件类型
Returns boolean
Inherited from Subscribe.hasListener
- Defined in utils/subscribe.ts:43

join

join(options: {
    roomId: undefined | string | number;
    type: RTCType;
    userId: string;
    voiceId: string;
}): Promise<boolean>
加入房间。

Returns
Parameters
- options: {
      roomId: undefined | string | number;
      type: RTCType;
      userId: string;
      voiceId: string;
  }
  - roomId: undefined | string | number
  - type: RTCType
  - userId: string
  - voiceId: string
Returns Promise<boolean>
- Defined in typings/rtc/protocol.ts:41

off

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

如果 name 不传的话解除对应所有事件如果 name, callback 不传的话解除所有name的所有事件
Type Parameters
- K extends 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
Inherited from Subscribe.off
- Defined in utils/subscribe.ts:92

on

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

Returns
解除事件
Type Parameters
- K extends 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
    解除事件
    
    Returns void
Inherited from Subscribe.on
- Defined in utils/subscribe.ts:57

once

once<K>(name: K, callback: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>)): (() => void)
注册事件(是否只执行一次)

Returns
解除事件
Type Parameters
- K extends 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
    解除事件
    
    Returns void
Inherited from Subscribe.once
- Defined in utils/subscribe.ts:76

quit

quit(): Promise<boolean>
离开房间。

Returns

Returns Promise<boolean>
- Defined in typings/rtc/protocol.ts:52

`Optional` shock

shock(): void
震动。

Returns void
- Defined in typings/rtc/protocol.ts:68

toggleMicro

toggleMicro(flag?: boolean): Promise<boolean>
关闭\开启本地麦克风。
Parameters
- Optional flag: boolean
Returns Promise<boolean>
- Defined in typings/rtc/protocol.ts:63

Interface RTCProtocol

Hierarchy

Implemented by

Index

Properties

Methods

Properties

joined

micro

type

voiceId

Methods

Optional checkRequirement

Returns Promise<CheckResult>

detectMicro

Returns

Returns Promise<boolean>

emit

Returns

Type Parameters

K extends keyof RTCEventType

Parameters

name: K

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

Returns boolean

hasListener

Parameters

name: keyof RTCEventType

Returns boolean

join

Returns

Parameters

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

roomId: undefined | string | number

type: RTCType

userId: string

voiceId: string

Returns Promise<boolean>

off

Type Parameters

K extends keyof RTCEventType

Parameters

Optional name: K

Optional callback: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>)

Parameters

Rest ...args: Parameters<RTCEventType[K]>

Returns ReturnType<RTCEventType[K]>

Returns void

on

Returns

Type Parameters

K extends keyof RTCEventType

Parameters

name: K

callback: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>)

Parameters

Rest ...args: Parameters<RTCEventType[K]>

Returns ReturnType<RTCEventType[K]>

Optional once: boolean

Returns (() => void)

Returns

Returns void

once

Returns

Type Parameters

K extends keyof RTCEventType

Parameters

name: K

callback: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>)

Parameters

Rest ...args: Parameters<RTCEventType[K]>

Returns ReturnType<RTCEventType[K]>

Returns (() => void)

Returns

Returns void

quit

Returns

Returns Promise<boolean>

Optional shock

Returns void

`Optional` checkRequirement

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

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

`Optional` name: K

`Optional` callback: ((...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>)

`Rest` ...args: Parameters<RTCEventType[K]>

`Rest` ...args: Parameters<RTCEventType[K]>

`Optional` once: boolean

`Rest` ...args: Parameters<RTCEventType[K]>

`Optional` shock

`Optional` flag: boolean