RTCProtocol | 如视 Live SDK

Hierarchy

Subscribe<RTCEventType>
- RTCProtocol

Implemented by

Index

Properties

Methods

Properties

joined

joined: boolean

micro

micro: boolean

type

type: RTCType

voiceId

voiceId: string

Methods

detectMicro

detectMicro(): Promise<boolean>

- Defined in typings/RTCProtocol.ts:30
监测麦克风授权。

Returns Promise<boolean>

emit

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

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

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

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

join

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

- Defined in typings/RTCProtocol.ts:20
加入房间。

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

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

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

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

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>

- Defined in typings/RTCProtocol.ts:25
离开房间。

Returns Promise<boolean>

shock

shock(): void

- Defined in typings/RTCProtocol.ts:40
震动。

Returns void

toggleMicro

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

- Defined in typings/RTCProtocol.ts:35
关闭\开启本地麦克风。

Parameters
- Optional flag: boolean
Returns Promise<boolean>

Hierarchy

Implemented by

Index

Properties

Methods

Properties

joined

micro

type

voiceId

Methods

detectMicro

Returns Promise<boolean>

emit

Type parameters

K: keyof RTCEventType

Parameters

name: K

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

Returns boolean

hasListener

Parameters

name: keyof RTCEventType

Returns boolean

join

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: 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

Type parameters

K: 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 void

once

Type parameters

K: 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 void

quit

Returns Promise<boolean>

shock

Returns void

toggleMicro

Parameters

Optional flag: boolean

Returns Promise<boolean>