REST reference

/console

9 addresses under /console.All families · Refusal codes

Root

GET/console

modelread-only
roleread-only

Example response

{
  "model": "openmixer software",
  "role": "server"
}

Allocation

GETPATCH/console/allocation

auxwritable0–512, step 1
busRoofread-only
busesClaimedread-only
dcawritable0–512, step 1
declaredread-only
fxReturnwritable0–512, step 1
groupwritable0–512, step 1
inputChannelswritable0–512, step 1
mainwritable0–512, step 1
matrixwritable0–512, step 1
mixMinuswritable0–512, step 1
namewritable
refusedBusesread-only

Example response

{
  "aux": 1,
  "busRoof": 0,
  "busesClaimed": 0,
  "dca": 1,
  "declared": true,
  "fxReturn": 0,
  "group": 2,
  "inputChannels": 4,
  "main": 1,
  "matrix": 1,
  "mixMinus": 0,
  "name": "matrix probe",
  "refusedBuses": []
}

Bpm

GETPATCH/console/bpm

bpmwritable30–300

Example response

{
  "bpm": 120
}

GETPATCH/console/bpm/tap

paramsread-only
progressread-only
refusalread-only
reportread-only
runningwritable
startedAtread-only

Example response

{
  "running": false
}

Defaults

GETPATCH/console/defaults

gainDbwritable0–55 dB, step 1
padwritable
phantomwritable

Example response

{
  "gainDb": 32,
  "pad": false,
  "phantom": false
}

Locale

GETPATCH/console/locale

localewritable

Example response

{
  "locale": null
}

Pdc

GETPATCH/console/pdc

enabledwritable

Example response

{
  "enabled": false
}

Quantum

GETPATCH/console/quantum

floorwritable
livewritable
ratewritable

Example response

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

Speaker align

GETPATCH/console/speakerAlign

micwritable
referencewritable

Example response

{
  "mic": null,
  "reference": null
}