REST reference

/console

26 addresses under /console.All families · Refusal codes

Root

GET/console
  • modelread-only
  • roleread-only
Example response
{
  "model": "openmixer software",
  "role": "server"
}

Addresses

GET/console/addresses
  • addressesread-only
  • namesread-only
  • portread-only
  • trustPortread-only
Example response
{
  "addresses": [
    "203.0.113.9"
  ],
  "names": [
    "matrix-probe"
  ],
  "port": 8443,
  "trustPort": 8880
}

Allocation

GETPATCH/console/allocation
  • auxwritablerange depends on the instance
  • busRoofread-only
  • busesClaimedread-only
  • dcawritablerange depends on the instance
  • declaredread-only
  • effectiveAtread-only
  • fxReturnwritablerange depends on the instance
  • groupwritablerange depends on the instance
  • inputChannelswritable0–512, step 1
  • mainwritablerange depends on the instance
  • matrixwritablerange depends on the instance
  • mixMinuswritablerange depends on the instance
  • namewritable
  • pendingwritable
  • refusedBusesread-only
Example response
{
  "aux": 1,
  "busRoof": 0,
  "busesClaimed": 0,
  "dca": 1,
  "declared": true,
  "effectiveAt": "none",
  "fxReturn": 0,
  "group": 2,
  "inputChannels": 4,
  "main": 1,
  "matrix": 1,
  "mixMinus": 0,
  "name": "matrix probe",
  "pending": null,
  "refusedBuses": []
}
GET/console/allocation/proposal
  • blockedShrinksread-only
  • currentread-only
  • outgrownread-only
  • proposedread-only
  • templatesread-only
Example response
{
  "blockedShrinks": [
    {
      "holds": 1,
      "pool": "main",
      "using": [
        "main/1"
      ]
    },
    {
      "holds": 1,
      "pool": "inputChannels",
      "using": [
        "input/1"
      ]
    }
  ],
  "current": {
    "aux": 1,
    "dca": 1,
    "fxReturn": 0,
    "group": 2,
    "inputChannels": 4,
    "main": 1,
    "matrix": 1,
    "mixMinus": 0,
    "name": "matrix probe"
  },
  "outgrown": true,
  "proposed": {
    "aux": 0,
    "dca": 0,
    "fxReturn": 0,
    "group": 0,
    "inputChannels": 8,
    "main": 1,
    "matrix": 0,
    "mixMinus": 0,
    "name": "matrix probe"
  },
  "templates": [
    {
      "aux": 8,
      "dca": 8,
      "fxReturn": 4,
      "group": 8,
      "id": "default",
      "inputChannels": 16,
      "label": "Default (16:8)",
      "main": 2,
      "matrix": 4,
      "mixMinus": 0,
      "name": ""
    },
    {
      "aux": 32,
      "dca": 16,
      "fxReturn": 4,
      "group": 16,
      "id": "64-32",
      "inputChannels": 64,
      "label": "64 in : 32 out",
      "main": 1,
      "matrix": 8,
      "mixMinus": 0,
      "name": ""
    }
  ]
}

Bpm

GETPATCH/console/bpm
  • bpmwritable30–300
  • clockread-only
  • sourcewritable

    manual · midi-clock

Example response
{
  "bpm": 120,
  "clock": {
    "clamped": false,
    "ignored": 0,
    "running": false,
    "state": "absent"
  },
  "source": "manual"
}
GETPATCH/console/bpm/tap
  • paramsread-only
  • progressread-only
  • refusalread-only
  • reportread-only
  • runningwritable
  • startedAtread-only
Example response
{
  "running": false
}

Build

GET/console/build
  • bootIdread-only
  • buildread-only
Example response
{
  "bootId": "00000000-0000-0000-0000-000000000000",
  "build": "v0.0.0-probe"
}

Defaults

GETPATCH/console/defaults
  • deskGainDbwritable-24–55 dB, step 1
  • gainDbwritable0–55 dB, step 1
  • padwritable
  • phantomwritable
Example response
{
  "deskGainDb": 0,
  "gainDb": 32,
  "pad": false,
  "phantom": false
}

Idle-policy

GET/console/idle-policy
  • factsread-only
  • targetUsread-only0–2000, step 1
Example response
{
  "facts": null,
  "targetUs": 10
}

Language

GETon demand/console/language/{lang}

e.g. /console/language/ca

  • codesread-only
  • langread-only
  • stringsread-only
Example response
{
  "codes": {
    "contract.dir.absent": "Cap directori de contracte a {path}"
  },
  "lang": "ca",
  "strings": {
    "WEB_UI.common.action.save": "Desa"
  }
}

Languages

GET/console/languages
  • languagesread-only
Example response
{
  "languages": [
    "ca",
    "es"
  ]
}

Locale

GETPATCH/console/locale
  • localewritable
Example response
{
  "locale": null
}

Pdc

GETPATCH/console/pdc
  • enabledwritable
Example response
{
  "enabled": false
}

Plugins

GETPATCH/console/plugins/hosting
  • inProcessEnabledwritable
  • realisedread-only
Example response
{
  "inProcessEnabled": false,
  "realised": false
}

Presets

GET/console/presets
  • presetsread-only
  • quantaread-only
Example response
{
  "presets": [
    {
      "name": "Safe",
      "quantum": 256,
      "rate": 48000
    },
    {
      "name": "Low",
      "quantum": 128,
      "rate": 96000
    },
    {
      "name": "Ultra",
      "quantum": 64,
      "rate": 96000
    }
  ],
  "quanta": [
    32,
    64,
    128,
    256,
    512,
    1024
  ]
}

Quantum

GETPATCH/console/quantum
  • floorwritable
  • livewritable
  • ratewritable

    44100 · 48000 · 88200 · 96000 · 176400 · 192000

Example response
{
  "floor": null,
  "live": null,
  "rate": null
}

Room

GET/console/room/positions
  • channelread-only
  • countread-only
  • minPositionsread-only
  • modesread-only
  • stableread-only
Example response
{
  "channel": "",
  "count": 0,
  "minPositions": 2,
  "modes": [],
  "stable": false
}
GETPATCH/console/room/positions/add
  • channelwritable
  • paramsread-only
  • progressread-only
  • refusalread-only
  • reportread-only
  • runningwritable
  • startedAtread-only
Example response
{
  "running": false
}
GETPATCH/console/room/positions/clear
  • paramsread-only
  • progressread-only
  • refusalread-only
  • reportread-only
  • runningwritable
  • startedAtread-only
Example response
{
  "running": false
}
GETPATCH/console/room/setup
  • stimuluswritable

    broadband · sweep

Example response
{
  "stimulus": "broadband"
}
GETPATCH/console/room/subArray
  • boxeswritable2–8, step 1
  • depthMwritable0.5–30 m, step 0.1
  • designHzwritable25–160 Hz, step 1
Example response
{
  "boxes": 4,
  "depthM": 5,
  "designHz": 63
}
GET/console/room/subArray/candidates
  • candidatesread-only
Example response
{
  "candidates": [
    {
      "delaysMs": [
        0,
        3.968253968253968
      ],
      "depthUsedM": 1.3611111111111112,
      "designFrequencyHz": 63,
      "elementCount": 2,
      "gratingLobeOnsetHz": 126,
      "pattern": "gradient-cardioid",
      "polarities": [
        1,
        -1
      ],
      "spacingM": 1.3611111111111112
    },
    {
      "delaysMs": [
        0,
        3.968253968253968
      ],
      "depthUsedM": 1.3611111111111112,
      "designFrequencyHz": 63,
      "elementCount": 2,
      "gratingLobeOnsetHz": 126,
      "pattern": "endfire",
      "polarities": [
        1,
        1
      ],
      "spacingM": 1.3611111111111112
    },
    {
      "delaysMs": [
        0,
        3.968253968253968,
        7.936507936507936,
        11.904761904761905
      ],
      "depthUsedM": 4.083333333333334,
      "designFrequencyHz": 63,
      "elementCount": 4,
      "gratingLobeOnsetHz": 126,
      "pattern": "endfire",
      "polarities": [
        1,
        1,
        1,
        1
      ],
      "spacingM": 1.3611111111111112
    }
  ]
}

Rt-capacity

GET/console/rt-capacity
  • capacityread-only
  • cycleNsread-only
  • linesread-only
  • provenanceread-only
  • quantumread-only
  • rateread-only
  • rigread-only
  • statusread-only
Example response
{
  "capacity": {
    "C": {
      "from": [
        "CYCLE_FIXED_NS[48000]",
        "LANE_WALK_NS[48000]",
        "STAGE_COST_NS_PER_SAMPLE (the live enables)",
        "the live racks (catalog nsPerSampleP95)",
        "RT_ADMISSION_CEILING_RATIO",
        "splitHeadroomRatio",
        "/console/rt-split facts: no CPU set read — the single walk",
        "no split facts published: W = 1"
      ],
      "maxInputs": {
        "admits": {
          "count": 66783,
          "workers": 1
        },
        "fitsWithHeadroom": {
          "count": 55616,
          "workers": 1
        }
      }
    },
    "M": {
      "unknown": [
        "DETOUR_NS[48000]",
        "DETOUR_NS_PER_SAMPLE[48000]",
        "costliest-live plugin[48000]"
      ]
    },
    "R": {
      "from": [
        "CYCLE_FIXED_NS[48000]",
        "LANE_WALK_NS[48000]",
        "STAGE_COST_NS_PER_SAMPLE[delay][48000]",
        "STAGE_COST_NS_PER_SAMPLE[reverb][48000]",
        "STAGE_COST_NS_PER_SAMPLE[eq][48000]",
        "STAGE_COST_NS_PER_SAMPLE[dynamics][48000]",
        "STAGE_COST_NS_PER_SAMPLE[gate][48000]",
        "STAGE_COST_NS_PER_SAMPLE[deEsser][48000]",
        "STAGE_COST_NS_PER_SAMPLE[drive][48000]",
        "STAGE_COST_NS_PER_SAMPLE[rotary][48000]",
        "STAGE_COST_NS_PER_SAMPLE[chorus][48000]",
        "STAGE_COST_NS_PER_SAMPLE[flanger][48000]",
        "STAGE_COST_NS_PER_SAMPLE[pitch][48000]",
        "STAGE_COST_NS_PER_SAMPLE[phaser][48000]",
        "STAGE_COST_NS_PER_SAMPLE[tremolo][48000]",
        "STAGE_COST_NS_PER_SAMPLE[geq][48000]",
        "SEND_NS_PER_SAMPLE[48000]",
        "RT_ADMISSION_CEILING_RATIO",
        "splitHeadroomRatio",
        "/console/rt-split facts: no CPU set read — the single walk",
        "no split facts published: W = 1"
      ],
      "maxInputs": {
        "admits": {
          "count": 44,
          "workers": 1
        },
        "fitsWithHeadroom": {
          "count": 36,
          "workers": 1
        }
      },
      "maxOut": {
        "admits": {
          "buses": {
            "aux": 384,
            "fxReturn": 4,
            "group": 192,
            "main": 1,
            "matrix": 96
          },
          "out": 384
        },
        "fitsWithHeadroom": {
          "buses": {
            "aux": 312,
            "fxReturn": 4,
            "group": 156,
            "main": 1,
            "matrix": 80
          },
          "out": 312
        }
      }
    },
    "T": {
      "unknown": [
        "STAGE_COST_NS_PER_SAMPLE[fbs][48000]",
        "STAGE_COST_NS_PER_SAMPLE[hrp][48000]"
      ]
    },
    "W": {
      "from": [
        "CYCLE_FIXED_NS[48000]",
        "LANE_WALK_NS[48000]",
        "RT_ADMISSION_CEILING_RATIO",
        "splitHeadroomRatio",
        "/console/rt-split facts: no CPU set read — the single walk",
        "no split facts published: W = 1"
      ],
      "maxInputs": {
        "admits": {
          "count": 72375,
          "workers": 1
        },
        "fitsWithHeadroom": {
          "count": 60302,
          "workers": 1
        }
      },
      "maxOut": {
        "admits": {
          "buses": {
            "aux": 512,
            "fxReturn": 4,
            "group": 256,
            "main": 1,
            "matrix": 128
          },
          "out": 512
        },
        "fitsWithHeadroom": {
          "buses": {
            "aux": 512,
            "fxReturn": 4,
            "group": 256,
            "main": 1,
            "matrix": 128
          },
          "out": 512
        }
      }
    },
    "X": {
      "unknown": [
        "DETOUR_NS[48000]",
        "DETOUR_NS_PER_SAMPLE[48000]",
        "costliest-live plugin[48000]"
      ]
    }
  },
  "cycleNs": 21333333.333333332,
  "lines": {
    "admitsRatio": 0.6,
    "ceilingRatio": 0.6,
    "fitsWithHeadroomRatio": 0.5,
    "headroomRatio": 0.1
  },
  "provenance": {
    "capacity.C.maxInputs": [
      "CYCLE_FIXED_NS[48000]",
      "LANE_WALK_NS[48000]",
      "STAGE_COST_NS_PER_SAMPLE (the live enables)",
      "the live racks (catalog nsPerSampleP95)",
      "RT_ADMISSION_CEILING_RATIO",
      "splitHeadroomRatio",
      "/console/rt-split facts: no CPU set read — the single walk",
      "no split facts published: W = 1",
      "rt-cost-seed: status=measured cpu=Intel(R) Core(TM) Ultra 9 275HX measuredAt=2026-10-06 rates=96000,192000 quanta=128,256,512 p95"
    ],
    "capacity.R.maxInputs": [
      "CYCLE_FIXED_NS[48000]",
      "LANE_WALK_NS[48000]",
      "STAGE_COST_NS_PER_SAMPLE[delay][48000]",
      "STAGE_COST_NS_PER_SAMPLE[reverb][48000]",
      "STAGE_COST_NS_PER_SAMPLE[eq][48000]",
      "STAGE_COST_NS_PER_SAMPLE[dynamics][48000]",
      "STAGE_COST_NS_PER_SAMPLE[gate][48000]",
      "STAGE_COST_NS_PER_SAMPLE[deEsser][48000]",
      "STAGE_COST_NS_PER_SAMPLE[drive][48000]",
      "STAGE_COST_NS_PER_SAMPLE[rotary][48000]",
      "STAGE_COST_NS_PER_SAMPLE[chorus][48000]",
      "STAGE_COST_NS_PER_SAMPLE[flanger][48000]",
      "STAGE_COST_NS_PER_SAMPLE[pitch][48000]",
      "STAGE_COST_NS_PER_SAMPLE[phaser][48000]",
      "STAGE_COST_NS_PER_SAMPLE[tremolo][48000]",
      "STAGE_COST_NS_PER_SAMPLE[geq][48000]",
      "SEND_NS_PER_SAMPLE[48000]",
      "RT_ADMISSION_CEILING_RATIO",
      "splitHeadroomRatio",
      "/console/rt-split facts: no CPU set read — the single walk",
      "no split facts published: W = 1",
      "rt-cost-seed: status=measured cpu=Intel(R) Core(TM) Ultra 9 275HX measuredAt=2026-10-06 rates=96000,192000 quanta=128,256,512 p95"
    ],
    "capacity.R.maxOut": [
      "CYCLE_FIXED_NS[48000]",
      "LANE_WALK_NS[48000]",
      "STAGE_COST_NS_PER_SAMPLE[delay][48000]",
      "STAGE_COST_NS_PER_SAMPLE[reverb][48000]",
      "STAGE_COST_NS_PER_SAMPLE[eq][48000]",
      "STAGE_COST_NS_PER_SAMPLE[dynamics][48000]",
      "STAGE_COST_NS_PER_SAMPLE[gate][48000]",
      "STAGE_COST_NS_PER_SAMPLE[deEsser][48000]",
      "STAGE_COST_NS_PER_SAMPLE[drive][48000]",
      "STAGE_COST_NS_PER_SAMPLE[rotary][48000]",
      "STAGE_COST_NS_PER_SAMPLE[chorus][48000]",
      "STAGE_COST_NS_PER_SAMPLE[flanger][48000]",
      "STAGE_COST_NS_PER_SAMPLE[pitch][48000]",
      "STAGE_COST_NS_PER_SAMPLE[phaser][48000]",
      "STAGE_COST_NS_PER_SAMPLE[tremolo][48000]",
      "STAGE_COST_NS_PER_SAMPLE[geq][48000]",
      "SEND_NS_PER_SAMPLE[48000]",
      "RT_ADMISSION_CEILING_RATIO",
      "splitHeadroomRatio",
      "/console/rt-split facts: no CPU set read — the single walk",
      "no split facts published: W = 1",
      "presetBuses(inputs, out)",
      "ALLOCATION_COUNT_CODEC",
      "rt-cost-seed: status=measured cpu=Intel(R) Core(TM) Ultra 9 275HX measuredAt=2026-10-06 rates=96000,192000 quanta=128,256,512 p95"
    ],
    "capacity.W.maxInputs": [
      "CYCLE_FIXED_NS[48000]",
      "LANE_WALK_NS[48000]",
      "RT_ADMISSION_CEILING_RATIO",
      "splitHeadroomRatio",
      "/console/rt-split facts: no CPU set read — the single walk",
      "no split facts published: W = 1",
      "rt-cost-seed: status=measured cpu=Intel(R) Core(TM) Ultra 9 275HX measuredAt=2026-10-06 rates=96000,192000 quanta=128,256,512 p95"
    ],
    "capacity.W.maxOut": [
      "CYCLE_FIXED_NS[48000]",
      "LANE_WALK_NS[48000]",
      "RT_ADMISSION_CEILING_RATIO",
      "splitHeadroomRatio",
      "/console/rt-split facts: no CPU set read — the single walk",
      "no split facts published: W = 1",
      "presetBuses(inputs, out)",
      "ALLOCATION_COUNT_CODEC",
      "rt-cost-seed: status=measured cpu=Intel(R) Core(TM) Ultra 9 275HX measuredAt=2026-10-06 rates=96000,192000 quanta=128,256,512 p95"
    ],
    "cycleNs": [
      "quantum / rate × 1e9"
    ],
    "lines": [
      "RT_ADMISSION_CEILING_RATIO",
      "splitHeadroomRatio (/console/rt-split)"
    ],
    "quantum": [
      "the live quantum"
    ],
    "rate": [
      "the live clock"
    ],
    "rig": [
      "/console/rt-split facts: no CPU set read — the single walk",
      "no split facts published: W = 1"
    ],
    "scaledBy": [
      "seed from ref-desk (Intel(R) Core(TM) Ultra 9 275HX) unanchored: its provenance carries no capability — the terms are read unscaled"
    ],
    "status.room.moreEnables": [
      "status.total.roomNs",
      "STAGE_COST_NS_PER_SAMPLE[kind][48000].max",
      "the lanes where kind is disabled"
    ],
    "status.room.moreInputs": [
      "capacity.*.maxInputs.admits",
      "the live input count"
    ],
    "status.target": [
      "RT_HARD_TARGET (core)",
      "cycleNs: quantum / rate × 1e9",
      "budgetNs: RT_ADMISSION_CEILING_RATIO × cycleNs",
      "predictRtCycleCost over the door desk at the target pace (the single walk: W = 1, the bound a re-partition only lowers)"
    ],
    "status.total.ceilingNs": [
      "RT_ADMISSION_CEILING_RATIO",
      "cycleNs"
    ],
    "status.total.measuredEmaNs": [
      "/telemetry/rt busyEma",
      "cycleNs"
    ],
    "status.total.predictedNs": [
      "predictRtCycleCost over the door desk",
      "CYCLE_FIXED_NS[48000]",
      "LANE_WALK_NS[48000]",
      "STAGE_COST_NS_PER_SAMPLE[*][48000]"
    ],
    "status.total.roomNs": [
      "status.total.ceilingNs",
      "status.total.predictedNs"
    ],
    "status.total.serialNs": [
      "CYCLE_FIXED_NS[48000]",
      "LANE_WALK_NS[48000] (MAIN)"
    ],
    "status.workers.measuredEmaNs": [
      "/console/rt-split facts.perWorker.busy",
      "cycleNs"
    ]
  },
  "quantum": 1024,
  "rate": 48000,
  "rig": {
    "kind": "live",
    "weights": [
      1
    ],
    "workers": 1
  },
  "status": {
    "room": {
      "moreEnables": {
        "dynamics": {
          "boundBy": "lanes",
          "count": 9
        },
        "eq": {
          "boundBy": "lanes",
          "count": 0
        },
        "gate": {
          "boundBy": "lanes",
          "count": 9
        }
      },
      "moreInputs": {
        "R": {
          "count": 40,
          "workers": 1
        },
        "T": {
          "unknown": [
            "STAGE_COST_NS_PER_SAMPLE[fbs][48000]",
            "STAGE_COST_NS_PER_SAMPLE[hrp][48000]"
          ]
        },
        "X": {
          "unknown": [
            "DETOUR_NS[48000]",
            "DETOUR_NS_PER_SAMPLE[48000]",
            "costliest-live plugin[48000]"
          ]
        },
        "currentChain": {
          "count": 66779,
          "workers": 1
        },
        "worstChain": {
          "unknown": [
            "DETOUR_NS[48000]",
            "DETOUR_NS_PER_SAMPLE[48000]",
            "costliest-live plugin[48000]"
          ]
        }
      }
    },
    "target": {
      "ceilingNs": 399999.99999999994,
      "cycleNs": 666666.6666666666,
      "fits": true,
      "predictedNs": 14958.079999999998,
      "predictedRatio": 0.022437119999999998,
      "quantum": 128,
      "rate": 192000,
      "roomNs": 385041.9199999999,
      "roomRatio": 0.5775628799999999,
      "unknown": []
    },
    "total": {
      "ceilingNs": 12799999.999999998,
      "measuredEmaNs": null,
      "measuredP95Ns": null,
      "predictedNs": 42743.024000000005,
      "predictedRatio": 0.0020035792500000004,
      "roomNs": 12757256.975999998,
      "roomRatio": 0.5979964207499999,
      "serialNs": 10480.400000000001
    },
    "unknown": [
      "measuredP95Ns — the engine publishes no busy p95 reservoir yet"
    ],
    "workers": [
      {
        "ceilingNs": 12799999.999999998,
        "cpu": null,
        "measuredEmaNs": null,
        "measuredP95Ns": null,
        "predictedNs": 42743.024000000005,
        "predictedRatio": 0.0020035792500000004,
        "roomNs": 12757256.975999998,
        "roomRatio": 0.5979964207499999,
        "worker": 0
      }
    ]
  }
}

Rt-split

GETPATCH/console/rt-split
  • ecoreWeightwritable
  • factsread-only
  • reservedCpuswritable
  • smtwritable

    one-per-core · all

  • spinNswritable
  • splitHeadroomRatiowritable
  • stallNswritable
  • workerswritable
Example response
{
  "ecoreWeight": "auto",
  "facts": null,
  "reservedCpus": [],
  "smt": "one-per-core",
  "spinNs": "auto",
  "splitHeadroomRatio": 0.1,
  "stallNs": "auto",
  "workers": "auto"
}

Speaker align

GETPATCH/console/speakerAlign
  • micwritable
  • referencewritable
  • referenceSidewritable

    L · R · C

Example response
{
  "mic": null,
  "reference": null,
  "referenceSide": "L"
}

Transport

GETPATCH/console/transport
  • barread-only
  • beatread-only
  • loopwritable
  • loopEndBeatswritable0–1000000
  • loopStartBeatswritable0–1000000
  • playingwritable
  • positionBeatswritable0–1000000
  • timeSignaturewritable

    2/4 · 3/4 · 4/4 · 5/4 · 6/4 · 7/4 · 3/8 · 5/8 · 6/8 · 7/8 · 9/8 · 12/8

Example response
{
  "bar": 1,
  "beat": 1,
  "loop": false,
  "loopEndBeats": 4,
  "loopStartBeats": 0,
  "playing": false,
  "positionBeats": 0,
  "timeSignature": "4/4"
}

openmixer

A software mixing console for Linux. The desk is the software; the browser is the surface.

Pages

Licence

OpenMixer is free software under the GPL-3.0-or-later. Every package in the workspace carries the same licence.

Roland, Midas, Behringer, RME and the product names used here belong to their respective owners. OpenMixer is an independent project and is not affiliated with any of them.