Download

Operator Actions

Every show operation — Cut, a scene to Preview, an overlay, the next PlayList row, the next track — as an action that a key, a Stream Deck button or the remote API can run.

Four ways to run the same action.

Keyboard

An action's shortcut works anywhere in the editor window of its page. It wins over the editor's own command on the same keys, but not over the focused panel's own key (Space on the PlayList, the Timeline's keys), and never while you type in a field.

Stream Deck

Use Put on a key in the action's form, or pick the action in a key's Action field in Logic › Stream Deck. The key names its page, so it runs that page's action whichever page the editor shows. The key lights from the action's state, such as an overlay on air or Auto Next on. Anything else set on the key runs after the action, under Also does.

Remote control

Action runs a saved action by its name or id. Every action type except Sequence is a function of its own too, with its fields as parameters. Both work over TCP, OSC and HTTP (Remote Control).

Text
FUNCTION Action Name=Goal sting
FUNCTION Cut
FUNCTION PreviewScene Scene=2
FUNCTION PGMOverlay Overlay=1&Scene=Bug&Mode=on
FUNCTION AudioPlaylistPlayNext Page=Show

HTTP

Shell
curl -X POST http://localhost:4004/api/pages/<pageId>/actions \
  -H "Content-Type: application/json" \
  -d '{"actionId":"<actionId>"}'

curl -X POST http://localhost:4004/api/pages/<pageId>/actions \
  -H "Content-Type: application/json" \
  -d '{"type":"PGMOverlay","params":{"overlay":2,"mode":"on"}}'

The answer is {"ok":true,"log":[…]} with what happened, or {"ok":false,"error":"…"}. The endpoint needs the machine's access token when one is set (Settings › System › Access).

Every run is written to the Logger with where it came from: [action shortcut], [action remote] and so on.