Get current live control state
singular_get_control_stateRetrieve the current on-air and staged animation state and payload values for each sub-composition in your Singular live graphics composition.
Instructions
Get the current on-air/staged state per sub-composition: its animation state (In/Out/Out1/Out2) and the current payload values keyed by control-node id. Use to see what is live right now.
Args: app/appToken; response_format. Returns { entries: [{ subCompositionId, subCompositionName, state, mainComposition, payload }] }.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app | No | Alias of a registered app instance (see register_app / list_apps). Preferred over a raw token. | |
| appToken | No | Raw Singular control-app token for a one-off/unregistered instance. If both 'app' and 'appToken' are given, 'appToken' wins. | |
| response_format | No | Output format: 'markdown' (human-readable) or 'json' (machine-readable). Default 'markdown'. | markdown |