openmixer — generated API reference
    Preparing search index...

    Type Alias LatencyBudgetParams

    The named fields a latency finding carries, for the client to interpolate. Product names (plugin) and units are do-not-translate; everything else is a number or an enum id.

    type LatencyBudgetParams = {
        budgetMs?: number;
        busIndex?: number;
        busKind?: string;
        busRole?: string;
        chainMaxMs?: number;
        chainMinMs?: number;
        chainMs?: number;
        headroomMs?: number;
        measuredMs?: number;
        plugin?: string;
        pluginUri?: string;
        rate?: number;
        rateBasis?: string;
        unresolved?: number;
        unresolvedPlugin?: string;
    }
    Index
    budgetMs? busIndex? busKind? busRole? chainMaxMs? chainMinMs? chainMs? headroomMs? measuredMs? plugin? pluginUri? rate? rateBasis? unresolved? unresolvedPlugin?
    budgetMs?: number
    busIndex?: number
    busKind?: string

    The destination itself, so the sentence can name it.

    busRole?: string

    The destination's role — monitor / program / effects.

    chainMaxMs?: number
    chainMinMs?: number

    Both ends, when the total is a span (a parameter-dependent plugin is in the chain).

    chainMs?: number

    The chain's accumulated latency in ms — the figure that is actually judged.

    headroomMs?: number

    How much of the budget is left (negative when over).

    measuredMs?: number

    That plugin's own latency in ms (its span's upper end when it is a span).

    plugin?: string

    The plugin that costs the most in this chain — the one to remove first.

    pluginUri?: string
    rate?: number

    The sample rate the judgement used, in Hz. Absent when none was reachable.

    rateBasis?: string

    Where that rate came from — live / worst-across-rates / unknown.

    unresolved?: number

    How many plugins in the chain could not be resolved at this rate.

    unresolvedPlugin?: string

    The first such plugin, so the operator knows which one is unmeasured.

    Settings
    Member Visibility

    On This Page
    Properties