openmixer — generated API reference
    Preparing search index...

    Interface TelemetryBroadcasterOptions

    Options for TelemetryBroadcaster. Poll rate defaults to TELEMETRY_HZ.

    interface TelemetryBroadcasterOptions {
        clearInterval?: (handle: Timeout) => void;
        hz?: number;
        setInterval?: (fn: () => void, ms: number) => Timeout;
        sink: TelemetrySink;
        source?: LatencyReportSource;
    }

    Hierarchy

    • PolledFeedOptions
      • TelemetryBroadcasterOptions
    Index
    clearInterval? hz? setInterval? sink source?
    clearInterval?: (handle: Timeout) => void
    hz?: number

    Poll rate in Hz. Each feed declares its own default.

    setInterval?: (fn: () => void, ms: number) => Timeout

    Timer hooks (override in tests). Default the global timers.

    sink: TelemetrySink

    Where to deliver each tick.

    source?: LatencyReportSource

    The engine-side latency measurement, when the console has one.

    Settings
    Member Visibility

    On This Page
    Properties