REST reference

/vsc

2 addresses under /vsc.All families · Refusal codes

Root

GETPATCH/vsc

convertBytesread-only
convertTotalBytesread-only
engagedwritable
engagedCountread-only
findingread-only
graphRateread-only
lengthFramesread-only
phaseread-only
playingwritable
positionFrameswritable0–16588800000
progressread-only
rateread-only
skippedEmptyread-only
takeIdwritable
takeRateread-only
trackCountread-only
underrunsread-only

Example response

{
  "convertBytes": 0,
  "convertTotalBytes": 0,
  "engaged": false,
  "engagedCount": 0,
  "finding": "",
  "graphRate": 0,
  "lengthFrames": 0,
  "phase": "idle",
  "playing": false,
  "positionFrames": 0,
  "progress": 0,
  "rate": 0,
  "skippedEmpty": [],
  "takeId": "",
  "takeRate": 0,
  "trackCount": 0,
  "underruns": 0
}

Eject

GETPATCH/vsc/eject

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

Example response

{
  "running": false
}