Get the output's state
GET/v1/outputs/{id}/state
Send an API key as a bearer token.
What's on an output now: what's on air, every value it's been given and how its timers read.
Path parameters
idstringRequired
The output's id.
Response
revisioninteger
Goes up with every change to the output.
activeobject | null
The version the output plays:
compositionId, versionId and versionNumber. Null until it's given a composition.onAirobject
Layers and components by id:
true on air, false off.dataobject
The values sent so far, as
global, layers by layer id and components by component id. Each holds values by field key. Fields not listed show their defaults.timersobject
Every timer field by id, with its
text as it reads now and whether it's running.liveInstancesobject
Which instance each component on air is showing, by component id.
To follow changes as they happen, rather than asking again and again, open the control WebSocket.