openmixer — generated API reference
    Preparing search index...

    Interface MeterTick

    One READ of an adapter's meters, offered to the console as a tick it drives — the demand-gate's seam (an internal spec §4). The adapter owns WHAT a read is (its source, its channel list, the loudness integrator riding it); the console owns WHEN, running the tick only while /meters has a watcher, so a console nobody is looking at reads no meter at all. An adapter with no tick pushes its meters itself (a hardware desk's own meter subscription) or has none — either way the console has nothing to drive, and says so by the absence.

    interface MeterTick {
        hz: number;
        drain(): Promise<void>;
        poll(): Promise<void>;
        reset(): void;
    }
    Index
    hz: number

    The rate this tick is meant to be driven at (Hz) — the adapter's declared meter rate, the one fact its own per-read integrators (loudness) are calibrated to.

    • Read the source once and DROP what it returns. A read-and-clear source (the native mixer's peaks and clip flags) accumulates while nobody reads it, so the first read after a gap carries the loudest moment of the gap, not the present — the console drains it rather than paint it (demand gate §4, the resume-read rule).

      Returns Promise<void>

    • Read the source once and fan the frame out to the receiver (onMeters).

      Returns Promise<void>

    • Forget every reading the tick carries across reads (the loudness integrator): the console stopped driving it, and an integral with a hole in it is not a measurement.

      Returns void