Class VRWebViewRTC

Hierarchy

CoreRTC
- VRWebViewRTC

Index

Constructors

constructor

Properties

Accessors

jsBridge

Methods

Constructors

constructor

new VRWebViewRTC(__namedParameters: VRWebViewRTCOptions): VRWebViewRTC

Overrides CoreRTC.constructor
- Defined in rtc/VRWebViewRTC.ts:22
Parameters
- __namedParameters: VRWebViewRTCOptions
Returns VRWebViewRTC

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

- Defined in rtc/VRWebViewRTC.ts:18
Returns JSBridgeProtocol

Methods

detectMicro

detectMicro(): Promise<boolean>

Overrides CoreRTC.detectMicro
- Defined in rtc/VRWebViewRTC.ts:100
监测麦克风授权。

Returns Promise<boolean>

emit

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

Inherited from CoreRTC.emit
- Defined in utils/subscribe.ts:122
触发事件

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

hasListener

hasListener(name: keyof RTCEventType): boolean

Inherited from CoreRTC.hasListener
- Defined in utils/subscribe.ts:43
判断是否注册了事件

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

join

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

Overrides CoreRTC.join
- Defined in rtc/VRWebViewRTC.ts:41
加入房间。

Parameters
- options: { roomId: string; type: RTCType; userId: string; voiceId: string }
  - roomId: string
  - 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 CoreRTC.off
- Defined in utils/subscribe.ts:92
解除事件

如果 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

on

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

Inherited from CoreRTC.on
- Defined in utils/subscribe.ts:57
注册事件

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 void
    解除事件

once

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

Inherited from CoreRTC.once
- Defined in utils/subscribe.ts:76
注册事件(是否只执行一次)

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 void
    解除事件

quit

quit(): Promise<boolean>

Overrides CoreRTC.quit
- Defined in rtc/VRWebViewRTC.ts:89
离开房间。

Returns Promise<boolean>

shock

shock(): void

Overrides CoreRTC.shock
- Defined in rtc/VRWebViewRTC.ts:121
震动。

Returns void

toggleMicro

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

Overrides CoreRTC.toggleMicro
- Defined in rtc/VRWebViewRTC.ts:109
关闭\开启本地麦克风。

Parameters
- Optional flag: boolean
Returns Promise<boolean>