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

    Interface BaseOptions<ActionMap>

    初始化的基础配置参数

    interface BaseOptions<ActionMap extends BaseMap> {
        vrLink?: string;
        element?: HTMLDivElement | HTMLIFrameElement;
        logLevel?: "NONE" | "ERROR" | "WARN" | "INFO" | "DEBUG";
        actionMap?: Partial<ActionMap>;
        shakehandRetryTimes?: number;
        handshakeRetryStrategy?: {
            baseDelay?: number;
            maxDelay?: number;
            jitterRange?: [number, number];
        };
        enableAutoReconnect?: boolean;
        reconnectStrategy?: {
            baseDelay?: number;
            maxDelay?: number;
            jitterRange?: [number, number];
        };
        reconnectInterval?: number;
        maxReconnectAttempts?: number;
        security?: SecurityConfig;
    }

    Type Parameters

    Index

    Properties

    vrLink? element? logLevel? actionMap? shakehandRetryTimes? handshakeRetryStrategy? enableAutoReconnect? reconnectStrategy? reconnectInterval? maxReconnectAttempts? security?

    Properties

    vrLink?: string

    加载的 vr 链接

    element?: HTMLDivElement | HTMLIFrameElement

    加载 vr 的 iframe 标签或是 父级 div 标签

    logLevel?: "NONE" | "ERROR" | "WARN" | "INFO" | "DEBUG"

    输出的日志级别

    actionMap?: Partial<ActionMap>

    支持的方法列表

    shakehandRetryTimes?: number

    握手重试次数，默认 10 次

    handshakeRetryStrategy?: {
        baseDelay?: number;
        maxDelay?: number;
        jitterRange?: [number, number];
    }

    握手重试策略配置

    Type Declaration

    • OptionalbaseDelay?: number

      基础延迟时间（毫秒），默认 500ms

    • OptionalmaxDelay?: number

      最大延迟时间（毫秒），默认 5000ms

    • OptionaljitterRange?: [number, number]

      抖动因子范围，默认 [0.85, 1.15]

    enableAutoReconnect?: boolean

    是否启用自动重连，默认 true

    reconnectStrategy?: {
        baseDelay?: number;
        maxDelay?: number;
        jitterRange?: [number, number];
    }

    重连策略配置

    Type Declaration

    • OptionalbaseDelay?: number

      基础重连延迟时间（毫秒），默认 2000ms

    • OptionalmaxDelay?: number

      最大重连延迟时间（毫秒），默认 30000ms

    • OptionaljitterRange?: [number, number]

      抖动因子范围，默认 [0.8, 1.2]

    reconnectInterval?: number

    重连间隔时间（毫秒），默认 5000ms（已废弃，使用 reconnectStrategy）

    maxReconnectAttempts?: number

    最大重连次数，默认 5 次

    security?: SecurityConfig

    安全配置

    Settings

    Member Visibility

    On This Page

    Properties