REST reference

/record

3 addresses under /record.All families · Refusal codes

Root

GET/record

armedCountread-only
phaseread-only
positionFramesread-only
rateread-only
startedAtread-only
takeIdread-only
xrunsread-only

Example response

{
  "armedCount": 0,
  "phase": "idle",
  "positionFrames": 0,
  "rate": 0,
  "startedAt": 0,
  "takeId": "",
  "xruns": 0
}

Start

GETPATCH/record/start

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

Example response

{
  "running": false
}

Stop

GETPATCH/record/stop

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

Example response

{
  "running": false
}