openmixer — generated API reference
    Preparing search index...

    Interface ControlDescriptor

    Everything a numeric control needs in order to draw itself — produced from a declaration plus the current state, bound whole by the component. A component that binds this never imports a range constant, so it cannot draw one device's travel over another's.

    interface ControlDescriptor {
        default?: number;
        defaultFrom?:
            | "measured"
            | "driver"
            | "declared"
            | "desk"
            | "assumed"
            | "operator";
        disabled: boolean;
        max: number;
        min: number;
        reason?: Refusal;
        step: number;
        unit: | ""
        | "dB"
        | "dBu"
        | "dBFS"
        | "Hz"
        | "ms"
        | "s"
        | "min"
        | "%"
        | "x"
        | "cents";
    }
    Index
    default?: number

    The DECLARED reset/fresh target — where a double-click or "reset to default" lands, from the declaration (ControlLimit.default), never a number typed at a call site. Absent means the declaration names none and the surface offers only its own convention.

    defaultFrom?:
        | "measured"
        | "driver"
        | "declared"
        | "desk"
        | "assumed"
        | "operator"

    HOW the owner knows default — carried straight from ControlLimit.defaultFrom, present exactly where the default is.

    A widget binds the descriptor, so a surface that wants to say "declared, not measured" over a reset target reads it from here and never from a second fetch or an imported constant.

    disabled: boolean

    The control may not be moved right now — visible and read-only, never hidden.

    max: number

    Highest value the control may reach.

    min: number

    Lowest value the control may reach.

    reason?: Refusal

    Why it is disabled, as a coded refusal the surface renders through its locale.

    step: number

    The smallest difference the thing behind the control actually resolves.

    unit:
        | ""
        | "dB"
        | "dBu"
        | "dBFS"
        | "Hz"
        | "ms"
        | "s"
        | "min"
        | "%"
        | "x"
        | "cents"

    The engineering symbol the numbers are in (do-not-translate).