OPERATIVE SERVER EXAMPLE USAGE

CURRENT PLAYBACK STATUS

curl.exe http://localhost:3019/v0/state

GET THE CURRENT SHOW JSON

curl.exe http://localhost:3019/v0/show

LOAD ANOTHER SHOW

curl.exe -X POST -H "Content-Type: application/json" http://localhost:3019/v0/show --data @FILENAME

PLAY/PAUSE/STOP TIMELINE BY ID

  • curl.exe -X POST http://localhost:3019/v0/play/0
  • curl.exe -X POST http://localhost:3019/v0/pause/0
  • curl.exe -X POST http://localhost:3019/v0/stop/0

JUMP TO TIME

  • format "/v0/jump-to-time/{tl_id}?time={time}&state={state}"
  • {tl_id} is timeline id
  • {state} is play or pause
  • {time} is given in milliseconds

example curl.exe -X POST "localhost:3019/v0/jump-to-time/0?time=6000&state=pause"

JUMP TO CUE

  • format "/v0/jump-to-cue/{tl_id}/{cue_id}?state={state}"
  • {tl_id} is timeline id
  • {cue_id} is cue id
  • {state} is play or pause

example curl.exe -X POST "localhost:3019/v0/jump-to-cue/0/0?state=pause"

SEND INPUTS

curl.exe -X POST -H "Content-Type: application/json" http://localhost:3019/v0/inputs --data '[{"""key""": """Tomtar""", """value""": 0.5}]'

get about timelines info

curl localhost:3019/v0/timelines

returns

[ { "name": "Main Timeline", "id": "0" } ]

get about timelines cues for a timeline

curl localhost:3019/v0/cues/0

returns

[ { "name": "my cue", "id": "0" } ]

LISTEN FOR PLAYBACK UPDATE EVENTS

v0

curl.exe http://localhost:3019/v0/sse

or

curl.exe http://localhost:3019/v0/ndjson

returns a stream of

data: {"type":"playbackState","clockTime":1718196220087,"timelines":[{"id":"0","running":false,"timelineTime":62950,"startDelay":0}],"freeRunningRenders":{}}

data: {"type":"cueVisibility","clockTime":1718196220087,"cues":{"0_0":"Start"}}

v1

curl.exe http://localhost:3019/v1/sse

or

curl.exe http://localhost:3019/v1/ndjson

returns current state and then a stream of updates

data: {"type":"playbackState","clockTime":1718196220087,"timelines":[{"id":"0","running":false,"timelineTime":62950,"startDelay":0}],"freeRunningRenders":{}}

data: {"type":"cueVisibility","clockTime":1718196220087,"cues":{"0_0":"Start"}}

data: {"type":"playbackState","clockTime":1718196412628,"timelines":[{"id":"0","running":false,"timelineTime":61600,"startDelay":0}],"freeRunningRenders":{}}

data: {"type":"cueVisibility","clock_time":1718196412628,"cues":{"0_0":"Start"}}

CONTROL WATCHOUT 6 API

ENABLE TCP (DEFAULT)

  • curl.exe -X POST http://localhost:3019/v0/compat/tcp

DISABLE TCP UNTIL OPERATIVE RESTART

  • curl.exe -X DELTE http://localhost:3019/v0/compat/tcp

GET TCP ENABLE

  • curl.exe -X GET http://localhost:3019/v0/compat/tcp

ENABLE UDP (DEFAULT)

  • curl.exe -X POST http://localhost:3019/v0/compat/udp

DISABLE UDP UNTIL OPERATIVE RESTART

  • curl.exe -X DELTE http://localhost:3019/v0/compat/udp

GET UDP ENABLE

  • curl.exe -X GET http://localhost:3019/v0/compat/udp