openmixer — generated API reference
    Preparing search index...

    Interface ChannelPairSpec

    How one pair-shaped path spells its two ends.

    The path's leading /channel/… segments name one end; the other is two named keys further down the template. Which end leads, and whether the leading kind is written LITERALLY in the template, are the only two things that differ between pair rows.

    interface ChannelPairSpec {
        leadKind?:
            | "input"
            | "fxReturn"
            | "aux"
            | "mix"
            | "matrix"
            | "cue"
            | "main"
            | "fxSend"
            | "dca"
            | "muteGroup"
            | "mixMinus";
        leads: "destination"
        | "source";
        trailIndexKey: string;
        trailKindKey: string;
    }
    Index
    leadKind? leads trailIndexKey trailKindKey
    leadKind?:
        | "input"
        | "fxReturn"
        | "aux"
        | "mix"
        | "matrix"
        | "cue"
        | "main"
        | "fxSend"
        | "dca"
        | "muteGroup"
        | "mixMinus"

    The leading kind when the template writes it out (/channel/matrix/{index}) rather than carrying it as {kind}. Then {index} is the only leading variable — and the id does NOT repeat the kind, because the path already said it. Kind in the path stays kind in the path: a crosspoint id is { index, srcKind, srcIndex } on the wire, and adding a kind field would be a second spelling of one instance.

    leads: "destination" | "source"

    The end the /channel/… prefix names.

    trailIndexKey: string
    trailKindKey: string

    The trailing end's own wire keys — busKind/busIndex, srcKind/srcIndex.

    Settings
    Member Visibility

    On This Page
    Properties