Class RealseeVRSignalsClient<ActionMap, EventMap>

VR 信号客户端类 - 专注于连接管理和 Action 调用

这个类用于在父窗口中创建客户端实例，负责与 VR 应用建立通信连接，发送 Action 请求，监听事件，并管理连接状态。

Example

import { RealseeVRSignalsClient } from '@realsee/vr-signals'

const client = new RealseeVRSignalsClient({
  vrLink: 'http://localhost:3000/vr-app',
  element: iframeElement,
  logLevel: 'INFO'
})

// 监听事件
client.on('cameraUpdate', (data) => {
  console.log('相机更新:', data.state)
})

// 发送 Action
await client.send('setState', { mode: 'panorama' })

Type Parameters

ActionMap extends BaseMap = DefaultActionMap
Action 映射类型，默认为 DefaultActionMap
EventMap extends BaseMap = DefaultEventMap
Event 映射类型，默认为 DefaultEventMap

Hierarchy (View Summary)

Base<ActionMap, EventMap>
- RealseeVRSignalsClient

Constructors

constructor

new RealseeVRSignalsClient<
    ActionMap extends BaseMap = DefaultActionMap,
    EventMap extends BaseMap = DefaultEventMap,
>(
    options: ClientOptions<ActionMap>,
): RealseeVRSignalsClient<ActionMap, EventMap>
创建 VR 信号客户端实例
Type Parameters
- ActionMap extends BaseMap = DefaultActionMap
- EventMap extends BaseMap = DefaultEventMap
Parameters
- options: ClientOptions<ActionMap>
  客户端配置选项
Returns RealseeVRSignalsClient<ActionMap, EventMap>
Example
```
const client = new RealseeVRSignalsClient({
  vrLink: 'http://localhost:3000/vr-app',
  element: iframeElement,
  logLevel: 'INFO',
  handshakeRetryStrategy: {
    baseDelay: 500,
    maxDelay: 5000,
    jitterRange: [0.85, 1.15]
  }
})
```
Overrides Base.constructor
- Defined in src/Client.ts:182

Properties

subscribe: RealseeVRSignalsClient<ActionMap, EventMap> = ...

Deprecated

此属性已废弃，请直接使用 Client 实例的事件监听方法

迁移指南：

// 旧用法
client.subscribe.on('cameraUpdate', handler)

// 新用法
client.on('cameraUpdate', handler)

Accessors

actionMap

get actionMap(): undefined | Partial<ActionMap>
获取支持的方法列表（向后兼容）

Returns undefined | Partial<ActionMap>
Inherited from Base.actionMap
- Defined in src/Base.ts:52

actionManager

get actionManager(): StandardActionManager<ActionMap>
获取 Action 管理器

Returns StandardActionManager<ActionMap>
Inherited from Base.actionManager
- Defined in src/Base.ts:64

connectionStatus

get connectionStatus(): ConnectionStatus
获取连接状态

Returns ConnectionStatus
Inherited from Base.connectionStatus
- Defined in src/Base.ts:93

Methods

getOptions

getOptions(): Partial<BaseOptions<ActionMap>>
获取配置选项

Returns Partial<BaseOptions<ActionMap>>
Inherited from Base.getOptions
- Defined in src/Base.ts:100

onReady

onReady(callback: () => void): void
当消息桥接准备好时，执行回调
Parameters
- callback: () => void
Returns void
Inherited from Base.onReady
- Defined in src/Base.ts:278

onConnectionStatusChange

onConnectionStatusChange(
callback: (status: ConnectionStatus) => void,
): undefined | (() => void)
监听连接状态变化
Parameters
- callback: (status: ConnectionStatus) => void
Returns undefined | (() => void)
Inherited from Base.onConnectionStatusChange
- Defined in src/Base.ts:293

offConnectionStatusChange

offConnectionStatusChange(
callback: (status: ConnectionStatus) => void,
): undefined | void
取消连接状态监听
Parameters
- callback: (status: ConnectionStatus) => void
Returns undefined | void
Inherited from Base.offConnectionStatusChange
- Defined in src/Base.ts:301

reconnect

reconnect(): void
手动重连

Returns void
Inherited from Base.reconnect
- Defined in src/Base.ts:308

sendEvent

sendEvent<EventName extends string | number | symbol>(
eventName: EventName,
eventData: Parameters<EventMap[EventName]>[0],
): void
发送事件
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
- eventData: Parameters<EventMap[EventName]>[0]
Returns void
Inherited from Base.sendEvent
- Defined in src/Base.ts:337

on

on<EventName extends string | number | symbol>(
eventName: EventName,
callback: EventMap[EventName],
): () => void
监听事件（向后兼容，内部使用标准 addEventListener）
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
- callback: EventMap[EventName]
Returns () => void
Inherited from Base.on
- Defined in src/Base.ts:376

off

off<EventName extends string | number | symbol>(
eventName: EventName,
callback: EventMap[EventName],
): void
取消监听事件（向后兼容，内部使用标准 removeEventListener）
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
- callback: EventMap[EventName]
Returns void
Inherited from Base.off
- Defined in src/Base.ts:395

once

once<EventName extends string | number | symbol>(
eventName: EventName,
callback: EventMap[EventName],
): () => void
只监听一次事件（向后兼容，内部使用标准 addEventListener）
Type Parameters
- EventName extends string | number | symbol
Parameters
- eventName: EventName
- callback: EventMap[EventName]
Returns () => void
Inherited from Base.once
- Defined in src/Base.ts:404

dispose

dispose(): void
销毁

Returns void
Inherited from Base.dispose
- Defined in src/Base.ts:428

send

send<K extends string | number | symbol>(
action: K,
data: Parameters<ActionMap[K]>[0],
): Promise<ReturnType<ActionMap[K]>>
发送 Action 请求（带可用性检查）
Type Parameters
- K extends string | number | symbol
Parameters
- action: K
- data: Parameters<ActionMap[K]>[0]
Returns Promise<ReturnType<ActionMap[K]>>
Overrides Base.send
- Defined in src/Client.ts:202

callAction

callAction<K extends string | number | symbol>(
action: K,
data: Parameters<ActionMap[K]>[0],
): Promise<ReturnType<ActionMap[K]>>
Type Parameters
- K extends string | number | symbol
Parameters
- action: K
- data: Parameters<ActionMap[K]>[0]
Returns Promise<ReturnType<ActionMap[K]>>
Deprecated
此方法已废弃，请使用 send() 方法替代
See
send

迁移指南：
```
// 旧用法
const result = await client.callAction('setState', { mode: 'editing' })

// 新用法
const result = await client.send('setState', { mode: 'editing' })
```
- Defined in src/Client.ts:244

isActionAvailable

isActionAvailable<K extends string | number | symbol>(action: K): boolean
检查 Action 是否可用
Type Parameters
- K extends string | number | symbol
Parameters
- action: K
Returns boolean
- Defined in src/Client.ts:255

getAvailableActions

getAvailableActions(): (keyof ActionMap)[]
获取所有可用的 Actions

Returns (keyof ActionMap)[]
- Defined in src/Client.ts:262

onActionAvailabilityChange

onActionAvailabilityChange<K extends string | number | symbol>(
action: K,
callback: (available: boolean) => void,
): () => void
监听 Action 可用性变化
Type Parameters
- K extends string | number | symbol
Parameters
- action: K
- callback: (available: boolean) => void
Returns () => void
- Defined in src/Client.ts:269

onActionAvailabilityChangeAll

onActionAvailabilityChangeAll(
    callback: (
        event: { actions: (keyof ActionMap)[]; available: boolean },
    ) => void,
): () => void
监听所有 Action 可用性变化
Parameters
- callback: (event: { actions: (keyof ActionMap)[]; available: boolean }) => void
Returns () => void
- Defined in src/Client.ts:279

waitForAction

waitForAction<K extends string | number | symbol>(
action: K,
timeout?: number,
): Promise<void>
等待特定 Action 可用
Type Parameters
- K extends string | number | symbol
Parameters
- action: K
- timeout: number = 30000
Returns Promise<void>
- Defined in src/Client.ts:286

getActionStats

getActionStats(): {
    available: number;
    total: number;
    availableActions: (keyof ActionMap)[];
}
获取 Action 统计信息

Returns { available: number; total: number; availableActions: (keyof ActionMap)[] }
- Defined in src/Client.ts:310

addEventListener

addEventListener(
    type: string,
    listener: null | EventListener | EventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
添加事件监听器（标准方法）
Parameters
- type: string
  事件类型
- listener: null | EventListener | EventListenerObject
  事件监听器
- Optionaloptions: boolean | AddEventListenerOptions
  选项
Returns void
Inherited from Base.addEventListener
- Defined in src/StandardEventTarget.ts:12

removeEventListener

removeEventListener(
    type: string,
    listener: null | EventListener | EventListenerObject,
    options?: boolean | EventListenerOptions,
): void
移除事件监听器（标准方法）
Parameters
- type: string
  事件类型
- listener: null | EventListener | EventListenerObject
  事件监听器
- Optionaloptions: boolean | EventListenerOptions
  选项
Returns void
Inherited from Base.removeEventListener
- Defined in src/StandardEventTarget.ts:26

dispatchEvent

dispatchEvent(event: Event): boolean
分发事件（标准方法）
Parameters
- event: Event
  事件对象
Returns boolean
是否被取消
Inherited from Base.dispatchEvent
- Defined in src/StandardEventTarget.ts:39

dispatchCustomEvent

dispatchCustomEvent<T = any>(
    type: string,
    detail?: T,
    options?: CustomEventInit<T>,
): boolean
创建并分发自定义事件
Type Parameters
- T = any
Parameters
- type: string
  事件类型
- Optionaldetail: T
  事件详情
- Optionaloptions: CustomEventInit<T>
  事件选项
Returns boolean
是否被取消
Inherited from Base.dispatchCustomEvent
- Defined in src/StandardEventTarget.ts:50

dispatchBuiltInEvent

dispatchBuiltInEvent(type: string, options?: EventInit): boolean
创建并分发内置事件
Parameters
- type: string
  事件类型
- Optionaloptions: EventInit
  事件选项
Returns boolean
是否被取消
Inherited from Base.dispatchBuiltInEvent
- Defined in src/StandardEventTarget.ts:70

hasEventListener

hasEventListener(type: string): boolean
检查是否有指定类型的事件监听器
Parameters
- type: string
  事件类型
Returns boolean
是否有监听器
Inherited from Base.hasEventListener
- Defined in src/StandardEventTarget.ts:84

getListenerCount

getListenerCount(type: string): number
获取事件监听器数量（近似值）
Parameters
- type: string
  事件类型
Returns number
监听器数量
Inherited from Base.getListenerCount
- Defined in src/StandardEventTarget.ts:95

removeAllListeners

removeAllListeners(type: string): void
移除指定类型的所有事件监听器
Parameters
- type: string
  事件类型
Returns void
Inherited from Base.removeAllListeners
- Defined in src/StandardEventTarget.ts:105

addEventListenerWithAbort

addEventListenerWithAbort(
    type: string,
    listener: null | EventListener | EventListenerObject,
    options?: AddEventListenerOptions,
    signal?: AbortSignal,
): () => void
使用 AbortController 添加事件监听器
Parameters
- type: string
  事件类型
- listener: null | EventListener | EventListenerObject
  事件监听器
- Optionaloptions: AddEventListenerOptions
  选项
- Optionalsignal: AbortSignal
  AbortSignal
Returns () => void
清理函数
Inherited from Base.addEventListenerWithAbort
- Defined in src/StandardEventTarget.ts:119

Class RealseeVRSignalsClient<ActionMap, EventMap>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RealseeVRSignalsClient<ActionMap, EventMap>

Example

Properties

subscribe

Deprecated

See

Accessors

actionMap

Returns undefined | Partial<ActionMap>

actionManager

Returns StandardActionManager<ActionMap>

connectionStatus

Returns ConnectionStatus

Methods

getOptions

Returns Partial<BaseOptions<ActionMap>>

onReady

Parameters

Returns void

onConnectionStatusChange

Parameters

Returns undefined | (() => void)

offConnectionStatusChange

Parameters

Returns undefined | void

reconnect

Returns void

sendEvent

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns () => void

off

Type Parameters

Parameters

Returns void

once

Type Parameters

Parameters

Returns () => void

dispose

Returns void

send

Type Parameters

Parameters

Returns Promise<ReturnType<ActionMap[K]>>

callAction

Type Parameters

Parameters

Returns Promise<ReturnType<ActionMap[K]>>

Deprecated

See

isActionAvailable

Type Parameters

Parameters

Returns boolean

getAvailableActions

Returns (keyof ActionMap)[]

onActionAvailabilityChange

Type Parameters

Parameters

Returns () => void

onActionAvailabilityChangeAll

Parameters