openmixer — generated API reference
    Preparing search index...

    A remote console, addressed the way it declares itself.

    Index
    • The desk's whole declaration, in one request.

      Throws when the console cannot be reached or answers something that is not a contract. A surface with no contract has nothing to generate from, so this is the one call whose failure is fatal rather than degrading — the alternative is a surface that renders invented ranges.

      Returns Promise<ConsoleContract>

    • One instance's declaration.

      null on any refusal, and that is deliberate: a control whose declaration did not land is rendered disabled, never guessed. A null here must not become a fallback range.

      Parameters

      Returns Promise<ConsoleDeclaration | null>

    • Write fields on one instance.

      The three outcomes are kept apart because they mean different things to whoever asked: the write landed, the write landed and the audio refused it, or the write never happened.

      Parameters

      • path: string
      • id: ResourceId
      • delta: Readonly<Record<string, unknown>>

      Returns Promise<ConsoleWriteOutcome>

    • The concrete URL an instance is addressed at. undefined when the id does not fill it.

      Parameters

      Returns string | undefined

    • Watch the root stream — every committed change, one connection, snapshot first.

      Returns a stop function. The watch re-dials on its own with a doubling backoff, and reports the second and later opens separately, because "we just connected" and "we were away" call for different behaviour from the consumer.

      paths windows the stream by template prefix; it is DEMAND, not an inbox filter — a path admitted here holds that row's pump running on the console, so asking for everything when you read nine rows arms every analyser lane with nobody watching a trace.

      Parameters

      Returns () => void