Class VRWebViewRTC

rtc 基础抽象类

Hierarchy

CoreRTC
- VRWebViewRTC

Index

Constructors

constructor

new VRWebViewRTC(__namedParameters: VRWebViewRTCOptions): VRWebViewRTC
Parameters
- __namedParameters: VRWebViewRTCOptions
Returns VRWebViewRTC
Overrides CoreRTC.constructor
- Defined in rtc/VRWebViewRTC.ts:19

Properties

joined

joined: boolean = false

是否已经加入房间

micro

micro: boolean = false

麦克风状态

`Private` options

options: VRWebViewRTCOptions

type

type: RTCType = RTCType.RealseeVRWebViewRTC

rtc 实现类型

voiceId

voiceId: string = ''

语音房间ID

Accessors

jsBridge

get jsBridge(): JSBridgeProtocol
Returns JSBridgeProtocol
- Defined in rtc/VRWebViewRTC.ts:15

Methods

detectMicro

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

Returns

Returns Promise<boolean>
Overrides CoreRTC.detectMicro
- Defined in rtc/VRWebViewRTC.ts:85

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 CoreRTC.emit
- Defined in utils/subscribe.ts:122

hasListener

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

join

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

Returns
Parameters
- options: {
      roomId: string;
      type: RTCType;
      userId: string;
      voiceId: string;
  }
  - roomId: string
  - type: RTCType
  - userId: string
  - voiceId: string
Returns Promise<boolean>
Overrides CoreRTC.join
- Defined in rtc/VRWebViewRTC.ts:35

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 CoreRTC.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 CoreRTC.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 CoreRTC.once
- Defined in utils/subscribe.ts:76

quit

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

Returns

Returns Promise<boolean>
Overrides CoreRTC.quit
- Defined in rtc/VRWebViewRTC.ts:76

shock

shock(): void
震动。

Returns void
Overrides CoreRTC.shock
- Defined in rtc/VRWebViewRTC.ts:104

toggleMicro

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

Class VRWebViewRTC

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: VRWebViewRTCOptions

Returns VRWebViewRTC

Properties

joined

micro

Private options

type

voiceId

Accessors

jsBridge

Returns JSBridgeProtocol

Methods

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: string; type: RTCType; userId: string; voiceId: string; }

roomId: string

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

`Private` options

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

options: {
roomId: string;
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` flag: boolean