unsupported. Principle: content commands keep their type keys; all manipulation goes through control.Envelope (flat, no commands layer)
| Reserved key | Notes |
|---|---|
| area | Required. Single area "a3" or an array ["a3","a4"] (dispatched one by one; any failure answers error naming the area) |
| delta | Optional. Boolean-compatible. 1 = all numbers in this message are increments; default = absolute |
| action | Optional. Parameterless action command, string enum (table below) |
Every other key is one parameter command; a message may carry several parameter commands but at most one action; unknown keys answer invalid param: <key>.
Parameter Commands
| key | value | Applies to | Absolute (default) / Incremental (delta:1) |
|---|---|---|---|
| scroll | [x,y] / "x,y" / n | url, text, document, plugin | Scroll to position / relative scroll |
| scroll_x / scroll_y | number | url, text, document, plugin | Single-axis scroll to / relative |
| zoom | float factor | image, document | Zoom to factor / current × value |
| pan | [x,y] % | image | Pan to / relative pan (percent of the area size) |
| fit | string | image | Fit mode: contain/cover/fill/none/scale-down (delta n/a) |
| size | float factor | text | Font size to factor / current × value |
| padding | int percent | text | Padding as a percent (e.g. 10 = 10%), applies live without re-sending content (delta n/a) |
| page | integer | document | Jump to page N (clamped) / ±N pages |
| volume | int 0-100 | video, audio | Set volume / ±volume (clamp 0-100) |
| seek | int seconds | video, audio | Seek to N s / ±N s |
| refresh | string | url | ""/"auto" normal refresh; "force" hard refresh (WebView ignores its own HTTP cache); other values rejected (delta n/a) |
| interval | int seconds | url | Auto-refresh interval, 0 = stop (delta n/a) |
| send | any JSON | url, plugin | API-only pass-through (below; delta n/a) |
Note: document's scroll means pan while zoomed (pdf.js self-rendering; no effect when not zoomed); page is clamped to [1, page count].
action Commands (parameterless)
| action | Applies to | Semantics |
|---|---|---|
| play / pause / stop | video, audio | Play / pause / pause-and-rewind (stop stays API-only; the remote panel's equivalent button is the toggle blind control) |
| toggle | video, audio | Play/pause flip (blind entry point) |
| back / forward | url | History back/forward |
| reset | all types | Reset to the state right after content was sent (below) |
reset per type: image = zoom/pan/fit; video/audio = position/volume/play state; text = font size & scroll; document = page/zoom/scroll; url/plugin = back to the originally sent address (unlike refresh, which reloads the current page).
send Command (API only)
The payload is passed verbatim to the area page's JS bridge (SS.onCommand / superscreen event); its structure is up to the page author. Applies to url/plugin pages; template media types have no JS bridge and answer unsupported. Not offered by the remote panel — for Open Platform / API use only.
Type Verdict & Samples
Each area judges applicability by its current content type; inapplicable commands answer {"ret":"error","msg":"unsupported"}. Parameter coercion rules (lenient array/boolean/number forms) are in the protocol doc; values that can't convert answer invalid param: <key> — never silently ignored.
Page → platform: pages call SS.report(data) (wrapped as a user event, rate-limited to 30/min per device) — see "Developer Reference" in the Plugins book. The legacy superScreenEvent handler remains for compatibility (wrapped as a custom event).