ClassVRWebViewRTC

VR WebView RTC 实现

适用于在如视 VR App 的 WebView 或微信小程序环境中进行实时语音通信。 通过 JSBridge 与原生 App 通信，实现语音功能。

Example

import JSBridge from '@realsee/jsbridge-x'

const jsBridge = new JSBridge()
const rtc = new VRWebViewRTC({
  jsBridge,
  getVoiceSign: async (params) => {
    const response = await fetch('/api/get-voice-sign', {
      method: 'POST',
      body: JSON.stringify(params)
    })
    return response.json()
  }
})

// 加入房间
await rtc.join({
  voiceId: 'voice-id',
  userId: 'user-id',
  roomId: 'room-id',
  type: RTCType.RealseeVRWebViewRTC
})

Hierarchy (view full)

Constructors

constructor

Properties

joined micro type voiceId

Accessors

jsBridge

Methods

detectMicro emit hasListener join off on once quit reJoin shock toggleMicro

Constructors

constructor

  • new VRWebViewRTC(options): VRWebViewRTC

  • 创建 VRWebViewRTC 实例

    Parameters

    • options: VRWebViewRTCOptions

      配置选项，包含以下属性：

      • jsBridge: JSBridge 实例，必需，用于与原生 App 通信
      • getVoiceSign: 获取语音签名的函数，必需

    Returns VRWebViewRTC

Properties

joined

joined: boolean = false

是否已加入语音房间

micro

micro: boolean = false

麦克风是否开启

type

type: RTCType = RTCType.RealseeVRWebViewRTC

RTC 实现类型

voiceId

voiceId: string = ""

当前语音房间ID

Accessors

jsBridge

  • get jsBridge(): JSBridgeProtocol

  • 获取 JSBridge 实例

    Returns JSBridgeProtocol

    JSBridge 协议实例

Methods

detectMicro

  • detectMicro(): Promise<boolean>

  • 监测麦克风权限

    Returns Promise<boolean>

emit

  • emit<K>(name, ...data): boolean

  • 触发事件

    Type Parameters

    Parameters

    • name: K

      事件类型

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

      触发事件的数据

    Returns boolean

    canceled 是否被触发取消

hasListener

  • hasListener(name): boolean

  • 判断是否注册了事件

    Parameters

    Returns boolean

join

  • join(options): Promise<boolean>

  • 加入语音房间

    Parameters

    • options: {
          roomId: string;
          type: RTCType;
          userId: string;
          voiceId: string;
      }

      加入房间的选项

      • roomId: string

        房间ID

      • type: RTCType

        RTC类型

      • userId: string

        用户ID

      • voiceId: string

        语音房间ID

    Returns Promise<boolean>

    Promise 是否成功加入房间

off

  • off<K>(name?, callback?): void

  • 解除事件

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

    Type Parameters

    Parameters

    Returns void

on

  • on<K>(name, callback, once?): (() => void)

  • 注册事件

    Type Parameters

    Parameters

    Returns (() => void)

    解除事件

      • (): void

      • Returns void

once

  • once<K>(name, callback): (() => void)

  • 注册事件(是否只执行一次)

    Type Parameters

    Parameters

    Returns (() => void)

    解除事件

      • (): void

      • Returns void

quit

  • quit(): Promise<boolean>

  • 退出房间

    Returns Promise<boolean>

reJoin

  • reJoin(): Promise<boolean>

  • 重连

    Returns Promise<boolean>

shock

  • shock(): void

  • 震动

    Returns void

toggleMicro

  • toggleMicro(flag?): Promise<boolean>

  • 修改麦克风状态

    Parameters

    • Optionalflag: boolean

    Returns Promise<boolean>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods