REST reference

/surface

9 addresses under /surface.All families · Refusal codes

Autodetect

GETPATCH/surface/autodetect
  • paramsread-only
  • progressread-only
  • refusalread-only
  • reportread-only
  • runningwritable
  • startedAtread-only
Example response
{
  "running": false
}

Control24

GETPATCH/surface/control24
  • enabledwritable
  • runningread-only
Example response
{
  "enabled": false,
  "running": false
}

Detected

GET/surface/detected

No fields observed on the reference rig.

Gestures

GETPATCH/surface/gestures
  • confirmDestructivewritable
  • doubleTapMswritable100–600
  • longPressMswritable400–2000
Example response
{
  "confirmDestructive": true,
  "doubleTapMs": 300,
  "longPressMs": 800
}

Pages

GET/surface/pages
  • pagesread-only
Example response
{
  "pages": [
    {
      "index": 0
    }
  ]
}
GETPATCH/surface/pages/{index}

e.g. /surface/pages/0

  • namewritable
  • slotswritable
Example response
{
  "name": "probe",
  "slots": [
    {
      "index": 2,
      "kind": "input"
    }
  ]
}

Preferences

GETPATCH/surface/preferences
  • accentwritable

    orange · amber · teal · ice · green · violet · red · magenta · cyan

  • bayMenuPositionwritable

    top · right · bottom · left

  • confirmConfigApplywritable
  • densitywritable

    auto · compact · normal · comfortable

  • dismissedMissingKeywritable
  • eqFillModewritable

    summed · bands · off

  • eqTapwritable

    pre · post · both

  • finishwritable

    aluminium · graphite · black

  • hideUnpatchedwritable
  • modernChosenwritable
  • narrowOnOverflowwritable
  • occupiedPatchwritable

    warn · unpatch

  • panelTapwritable

    pre · post · both

  • perfRefreshMswritable250–60000 ms
  • sendBuswritable
  • stageStripEdgewritable

    top · right · bottom · left

  • stripScribblewritable

    value · name

  • stylewritable

    vintage · modern

  • themewritable

    dark · hc · light

  • traceToolbarwritable

    top · right · bottom · left

Example response
{
  "accent": "orange",
  "bayMenuPosition": "top",
  "confirmConfigApply": true,
  "density": "auto",
  "dismissedMissingKey": "",
  "eqFillMode": "summed",
  "eqTap": "both",
  "finish": "aluminium",
  "hideUnpatched": false,
  "modernChosen": false,
  "narrowOnOverflow": false,
  "occupiedPatch": "warn",
  "panelTap": "both",
  "perfRefreshMs": 1000,
  "sendBus": null,
  "stageStripEdge": "right",
  "stripScribble": "value",
  "style": "vintage",
  "theme": "dark",
  "traceToolbar": "top"
}

Selection

GETPATCH/surface/selection
  • channelwritable
Example response
{
  "channel": {
    "index": 1,
    "kind": "input"
  }
}

Touch

GETPATCH/surface/touch/{kind}/{index}

e.g. /surface/touch/input/1

  • touchedwritable
Example response
{
  "touched": false
}

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.