Class RealseeVRSignalsRemote<ActionMap, EventMap>

VR 信号远程控制类 - 专注于 Action 管理和执行

这个类用于在 VR 应用中创建远程控制实例，负责接收来自父窗口的 Action 请求，执行相应的处理逻辑，并支持动态注册和移除 Actions。

Example

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

const remote = new RealseeVRSignalsRemote({
  logLevel: 'INFO',
  actionMap: {
    setState(data) {
      console.log('状态更新:', data)
      return { success: true }
    }
  }
})

// 动态注册 Action
remote.registerAction('updateCamera', async (data) => {
  console.log('相机更新:', data)
  return { success: true }
})

Type Parameters

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

Hierarchy (View Summary)

Base<ActionMap, EventMap>
- RealseeVRSignalsRemote

Constructors

constructor

new RealseeVRSignalsRemote<
    ActionMap extends BaseMap = DefaultActionMap,
    EventMap extends BaseMap = DefaultEventMap,
>(
    options?: RemoteOptions<ActionMap>,
): RealseeVRSignalsRemote<ActionMap, EventMap>
创建 VR 信号远程控制实例
Type Parameters
- ActionMap extends BaseMap = DefaultActionMap
- EventMap extends BaseMap = DefaultEventMap
Parameters
- options: RemoteOptions<ActionMap> = {}
  远程控制配置选项
Returns RealseeVRSignalsRemote<ActionMap, EventMap>
Example
```
const remote = new RealseeVRSignalsRemote({
  logLevel: 'INFO',
  actionMap: {
    setState(data) {
      console.log('状态更新:', data)
      return { success: true }
    },
    updateCamera({ state }) {
      console.log('相机更新:', state)
      return { success: true }
    }
  }
})
```
Overrides Base.constructor
- Defined in src/Remote.ts:151

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

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]>>
Inherited from Base.send
- Defined in src/Base.ts:356

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

registerAction

registerAction<K extends string | number | symbol>(
name: K,
handler: ActionMap[K],
): void
注册单个 action
Type Parameters
- K extends string | number | symbol
Parameters
- name: K
- handler: ActionMap[K]
Returns void
- Defined in src/Remote.ts:174

registerActions

registerActions(actions: Partial<ActionMap>): void
批量注册 actions
Parameters
- actions: Partial<ActionMap>
Returns void
- Defined in src/Remote.ts:182

unregisterAction

unregisterAction<K extends string | number | symbol>(name: K): boolean
移除单个 action
Type Parameters
- K extends string | number | symbol
Parameters
- name: K
Returns boolean
- Defined in src/Remote.ts:192

unregisterActions

unregisterActions(names: (keyof ActionMap)[]): number
批量移除 actions
Parameters
- names: (keyof ActionMap)[]
Returns number
- Defined in src/Remote.ts:203

hasAction

hasAction<K extends string | number | symbol>(name: K): boolean
检查 action 是否已注册
Type Parameters
- K extends string | number | symbol
Parameters
- name: K
Returns boolean
- Defined in src/Remote.ts:221

getRegisteredActions

getRegisteredActions(): (keyof ActionMap)[]
获取已注册的 action 列表

Returns (keyof ActionMap)[]
- Defined in src/Remote.ts:228

clearActions

clearActions(): void
清空所有 actions

Returns void
- Defined in src/Remote.ts:235

onActionChange

onActionChange(
callback: (event: ActionChangeEvent<ActionMap>) => void,
): () => void
监听 action 变化事件
Parameters
- callback: (event: ActionChangeEvent<ActionMap>) => void
Returns () => void
- Defined in src/Remote.ts:244

onActionAvailabilityChange

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

getActionStats

getActionStats(): ActionStats
获取 action 统计信息

Returns ActionStats
- Defined in src/Remote.ts:284

getActionRegistry

getActionRegistry(): DynamicActionRegistry<ActionMap>
获取 action 注册器实例（用于高级操作）

Returns DynamicActionRegistry<ActionMap>
- Defined in src/Remote.ts:342

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 RealseeVRSignalsRemote<ActionMap, EventMap>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RealseeVRSignalsRemote<ActionMap, EventMap>

Example

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

send

Type Parameters

Parameters

Returns Promise<ReturnType<ActionMap[K]>>

on

Type Parameters

Parameters

Returns () => void

off

Type Parameters

Parameters

Returns void

once

Type Parameters

Parameters

Returns () => void

dispose

Returns void

registerAction

Type Parameters

Parameters

Returns void

registerActions

Parameters

Returns void

unregisterAction

Type Parameters

Parameters

Returns boolean

unregisterActions

Parameters

Returns number

hasAction

Type Parameters

Parameters

Returns boolean

getRegisteredActions

Returns (keyof ActionMap)[]

clearActions

Returns void

onActionChange