REST reference

/clock

6 addresses under /clock.All families · Refusal codes

Root

GET/clock
  • quantumread-only
  • rateread-only
  • supportedRatesread-only
Example response
{
  "quantum": 1024,
  "rate": 48000,
  "supportedRates": [
    44100,
    48000,
    88200,
    96000
  ]
}

Force

GETPATCH/clock/force
  • ratewritable

    0 · 44100 · 48000 · 88200 · 96000 · 176400 · 192000

  • rateNotAppliedread-only
Example response
{
  "rate": null,
  "rateNotApplied": false
}

Ownership

GETPATCH/clock/ownership
  • designatedReferencewritable
  • freeRunOverridewritable
  • rolewritable

    master · follower

Example response
{
  "designatedReference": "",
  "freeRunOverride": false,
  "role": "master"
}
GET/clock/ownership/reference
  • designatedread-only
  • eligibleread-only
  • flaggedread-only
  • lockDetailread-only
  • overrideread-only
  • paceLockedread-only
  • paceOwnerread-only
  • ratesread-only
  • reasonread-only
  • referenceread-only
Example response
{
  "designated": false,
  "eligible": false,
  "flagged": true,
  "lockDetail": "openmixer emits the pace; the REAC transport free-runs on the host clock (FreeREAC/reac-pw#75).",
  "override": false,
  "paceLocked": false,
  "paceOwner": "",
  "rates": [
    44100,
    48000,
    96000
  ],
  "reason": "No hardware clock on the graph worth propagating — let a stagebox own the pace instead.",
  "reference": null
}

References

GET/clock/references
  • referencesread-only
Example response
{
  "references": [
    {
      "driving": false,
      "grade": "synthetic",
      "id": "Dummy-Driver",
      "label": "Dummy-Driver",
      "priority": 200000,
      "reason": "a PipeWire software driver — it keeps time with a system timer, not with hardware"
    },
    {
      "driving": false,
      "grade": "synthetic",
      "id": "Freewheel-Driver",
      "label": "Freewheel-Driver",
      "priority": 190000,
      "reason": "a PipeWire software driver — it keeps time with a system timer, not with hardware"
    }
  ]
}

Warnings

GET/clock/warnings
  • warningsread-only
Example response
{
  "warnings": [
    {
      "detail": "No hardware clock on the graph worth propagating — let a stagebox own the pace instead.",
      "id": "clock:unqualified-master",
      "title": "Owning the pace without a qualifying reference",
      "titleCode": {
        "code": "clock.unqualified-master.title",
        "params": {}
      }
    }
  ]
}

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.