openmixer — generated API reference
    Preparing search index...

    Interface SurfaceWatchdogOptions

    Options for SurfaceWatchdog.

    interface SurfaceWatchdogOptions {
        adapters: AdapterManager;
        intervalMs?: number;
        logger?: (message: string) => void;
        now?: () => number;
        onChange?: () => void | Promise<void>;
        onDetected?: (found: readonly SurfaceDetection[]) => void | Promise<void>;
        retryBackoffMs?: number;
    }
    Index
    adapters intervalMs? logger? now? onChange? onDetected? retryBackoffMs?
    adapters: AdapterManager

    The manager whose probeable entries are supervised.

    intervalMs?: number

    Probe cadence. Default 2000 ms.

    logger?: (message: string) => void

    Diagnostics sink (default: silent).

    now?: () => number

    Clock (override in tests). Default Date.now.

    onChange?: () => void | Promise<void>

    Called when a tick changed anything observable (presence or status) — broadcast hook. May return a promise (e.g. it re-reads AdapterManager.list()); tick awaits it.

    onDetected?: (found: readonly SurfaceDetection[]) => void | Promise<void>

    The set of present-but-UNCONFIGURED surfaces changed — an X-Touch was plugged into a running console, or an offered one was pulled again. Fired only on a CHANGE, never once per tick: an offer that re-nags every 2 s is an offer the operator learns to ignore.

    Purely an OFFER. The watchdog does not add what it finds — the operator confirms via adapter.add, per the standing rule that a validated default is confirmable, never silently applied. Omit to leave new-surface detection off entirely.

    retryBackoffMs?: number

    Minimum gap between attach attempts after a failed one. Default 10000 ms.

    Settings
    Member Visibility

    On This Page
    Properties