Referència REST

/surface

8 adreces sota /surface.Totes les famílies · Codis de refús

Autodetect

GETPATCH/surface/autodetect

paramsnomés lectura
progressnomés lectura
refusalnomés lectura
reportnomés lectura
runningmodificable
startedAtnomés lectura

Resposta d'exemple

{
  "running": false
}

Detected

GET/surface/detected

No s'ha vist cap camp a l'equip de referència.

Gestures

GETPATCH/surface/gestures

confirmDestructivemodificable
doubleTapMsmodificable100–600
longPressMsmodificable400–2000

Resposta d'exemple

{
  "confirmDestructive": true,
  "doubleTapMs": 300,
  "longPressMs": 800
}

Pages

GET/surface/pages

pagesnomés lectura

Resposta d'exemple

{
  "pages": []
}

GET/surface/pages/{index}

p. ex. /surface/pages/1

No s'ha vist cap camp a l'equip de referència.

Preferences

GETPATCH/surface/preferences

bayMenuPositionmodificable
top · left · right
confirmConfigApplymodificable
densitymodificable
auto · compact · normal · comfortable
dismissedMissingKeymodificable
eqFillModemodificable
summed · bands · off
eqTapmodificable
pre · post · both
hideUnpatchedmodificable
narrowOnOverflowmodificable
occupiedPatchmodificable
warn · unpatch
panelTapmodificable
pre · post · both
processingPanelmodificable
sendBusmodificable
thememodificable
dark · hc · light

Resposta d'exemple

{
  "bayMenuPosition": "top",
  "confirmConfigApply": true,
  "density": "auto",
  "dismissedMissingKey": "",
  "eqFillMode": "summed",
  "eqTap": "both",
  "hideUnpatched": false,
  "narrowOnOverflow": false,
  "occupiedPatch": "warn",
  "panelTap": "both",
  "processingPanel": {},
  "sendBus": null,
  "theme": "dark"
}

Selection

GETPATCH/surface/selection

channelmodificable

Resposta d'exemple

{
  "channel": {
    "index": 1,
    "kind": "input"
  }
}

Touch

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

p. ex. /surface/touch/input/1

touchedmodificable

Resposta d'exemple

{
  "touched": false
}