openmixer — generated API reference
    Preparing search index...

    Interface ConsoleRow

    One entity instance as the console holds it: the root stream's event body, unserialised.

    path is the registered TEMPLATE (/channel/{kind}/{index}/fader) and id the instance's canonical address — the same pair a client keys its store by, so a consumer of this feed and a consumer of the SSE stream index their world identically.

    interface ConsoleRow {
        id: ResourceId;
        known?: readonly string[];
        path: string;
        rev?: number;
        state: object;
    }

    Hierarchy (View Summary)

    Index
    id known? path rev? state
    id: ResourceId
    known?: readonly string[]

    Which of the state's fields the row actually KNOWS, where it distinguishes them from a floor it is merely displaying (the head-amp's phantom/pad/SENS). Absent where the row makes no such distinction — never a claim that nothing is known.

    path: string
    rev?: number

    The console revision as of when the row was produced — the stamp the root stream's events carry, so a consumer running a ConvergenceClient accounts for what it received exactly as a browser tab does. Absent only on a console wired without the instrument.

    state: object

    Settings
    Member Visibility

    On This Page
    Properties