@realsee/vr-signals API Documentation - v2.0.0
    Preparing search index...

    Interface StandardVRSignalsAPI<ActionMap, EventMap>

    标准化的 VR Signals API 接口

    interface StandardVRSignalsAPI<
        ActionMap extends Record<string, (...args: any[]) => any>,
        EventMap extends Record<string, (...args: any[]) => any>,
    > {
        addEventListener(
            type: string,
            listener: null | EventListener | EventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: null | EventListener | EventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        dispatchEvent(event: Event): boolean;
        on<EventName extends string | number | symbol>(
            eventName: EventName,
            callback: EventMap[EventName],
        ): () => void;
        off<EventName extends string | number | symbol>(
            eventName: EventName,
            callback: EventMap[EventName],
        ): void;
        once<EventName extends string | number | symbol>(
            eventName: EventName,
            callback: EventMap[EventName],
        ): () => void;
        connect(): Promise<void>;
        disconnect(): void;
        reconnect(): Promise<void>;
        getConnectionStatus(): ConnectionStatus;
        isConnected(): boolean;
        isConnecting(): boolean;
        hasError(): boolean;
        ready(): Promise<void>;
        destroy(): void;
        sendEvent<EventName extends string | number | symbol>(
            eventName: EventName,
            data: Parameters<EventMap[EventName]>[0],
        ): void;
    }

    Type Parameters

    • ActionMap extends Record<string, (...args: any[]) => any>
    • EventMap extends Record<string, (...args: any[]) => any>
    Index

    Methods

    • Parameters

      • type: string
      • listener: null | EventListener | EventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • Parameters

      • type: string
      • listener: null | EventListener | EventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Parameters

      • event: Event

      Returns boolean

    • Returns Promise<void>

    • Returns void

    • Returns Promise<void>

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns Promise<void>

    • Returns void

    • Type Parameters

      • EventName extends string | number | symbol

      Parameters

      Returns void