openmixer — generated API reference
    Preparing search index...

    Interface InsertEngine

    The engine door every insert row reads and writes through — the owner of the live rack and of the commanded-value ledgers. Satisfied structurally by StructuralDspController.

    interface InsertEngine {
        insertChannels?(): readonly ChannelId[];
        insertControlsOf?(uri: string): readonly PluginParam[] | undefined;
        insertOffer?(channel: ChannelId): readonly string[] | undefined;
        insertRackOf(channel: ChannelId): readonly InsertSlotView[] | undefined;
        insertRackRefusal?(
            channel: ChannelId,
            plugins: readonly string[],
        ): Refusal | undefined;
        setInsertBypass(
            channel: ChannelId,
            slot: number,
            bypassed: boolean,
        ): Promise<unknown>;
        setInsertParam(
            channel: ChannelId,
            slot: number,
            symbol: string,
            value: number,
        ): Promise<unknown>;
        setInsertPatch(
            channel: ChannelId,
            slot: number,
            property: string,
            value: string | number,
        ): Promise<unknown>;
        setInsertPreset(
            channel: ChannelId,
            slot: number,
            presetUri: string,
        ): Promise<unknown>;
        setInsertRack(
            channel: ChannelId,
            plugins: readonly string[],
        ): Promise<unknown>;
    }
    Index
    • Every channel this console holds a rack for — the instance set all four insert rows walk.

      EMPTY RACKS ARE IN IT. The rack row is the collection a removal announces on: it names the plugins that remain, and a stream's opening burst has to carry it or a client holds no prior state for the frame the removal sends. A set narrowed to non-empty racks would make the row VANISH exactly when it emptied, which is the one moment it has something to say.

      Absent, the rows enumerate nothing and answer only what they are asked about.

      Returns readonly ChannelId[]

    • The CONTROL ports of a plugin, as the served descriptor declares them (/plugins/{uri}, params[] with kind: 'control') — the parameter row's instance roster and each instance's travel. Absent, or answering undefined for a URI, the row enumerates no parameter for that plugin and publishes no travel: a console without a catalog declares nothing it cannot stand behind, and a write still reaches the port by its symbol.

      Parameters

      • uri: string

      Returns readonly PluginParam[] | undefined

    • The plugins this strip may rack — the served roster narrowed by the strip's width, the offer OPTIONS publishes as plugins.values. Absent, or answering undefined, no vocabulary is published: a console without a catalog declares nothing it cannot stand behind.

      Parameters

      Returns readonly string[] | undefined

    • Why this rack would be refused by the destination-suitability judgement, or undefined when it is affordable. Absent on a door with no latency guard — then nothing is judged and nothing is refused, which is what a console without the guard already does.

      Parameters

      • channel: ChannelId
      • plugins: readonly string[]

      Returns Refusal | undefined

    • Bypass / un-bypass the plugin at slot (un-bypassing is judged like an add).

      Parameters

      • channel: ChannelId
      • slot: number
      • bypassed: boolean

      Returns Promise<unknown>

    • Set a control port on the plugin at slot.

      Parameters

      • channel: ChannelId
      • slot: number
      • symbol: string
      • value: number

      Returns Promise<unknown>

    • Set an lv2:Parameter on the plugin at slot.

      Parameters

      • channel: ChannelId
      • slot: number
      • property: string
      • value: string | number

      Returns Promise<unknown>

    • Load an LV2 preset into the plugin at slot.

      Parameters

      • channel: ChannelId
      • slot: number
      • presetUri: string

      Returns Promise<unknown>

    • Replace a whole rack, in audio order — the ONE write door for membership and order.

      Parameters

      • channel: ChannelId
      • plugins: readonly string[]

      Returns Promise<unknown>