WATCHOUT Server HTTP Commands

General Information

  • Current Playback Status curl http://localhost:3019/v0/state
  • Get the Current Show JSON curl http://localhost:3019/v0/show

Show Management

  • Load Show from JSON File curl -X POST -H "Content-Type: application/json" "http://localhost:3019/v0/show" --data @JsonFileName
  • Load Show from .watch File curl -X POST "http://localhost:3019/v0/showfile" --data-binary @ShowFileName
  • Load Show with Name curl -X POST "http://localhost:3019/v0/showfile?showName=TestShow" -H "Content-Type: application/octet-stream" --data-binary "@showfile.watch"

Timeline Control

  • Play Timeline by ID curl -X POST http://localhost:3019/v0/play/0
  • Pause Timeline by ID curl -X POST http://localhost:3019/v0/pause/0
  • Stop Timeline by ID curl -X POST http://localhost:3019/v0/stop/0
  • Jump to Time curl -X POST "localhost:3019/v0/jump-to-time/0?time=6000&state=pause"
  • Jump to Cue curl -X POST "localhost:3019/v0/jump-to-cue/0/0?state=pause"

Input Management

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

Timeline Information

  • Get Timelines Info curl localhost:3019/v0/timelines
  • Get Timeline Cues curl localhost:3019/v0/cues/0

Event Listening

  • Listen for Playback Update Events (v0) curl http://localhost:3019/v0/sse
  • Listen for Playback Update Events (v1) curl http://localhost:3019/v1/sse

Cue Sets

Get States

  • By Group ID curl http://localhost:3019/v0/cue-group-state/by-id
  • By Group Name curl http://localhost:3019/v0/cue-group-state/by-name

Switch a Single Variant

  • By Group ID and Variant ID curl -X POST http://localhost:3019/v0/cue-group-state/by-id//
  • By Group Name and Variant Name curl -X POST http://localhost:3019/v0/cue-group-state/by-name//

Switch Multiple Variants

  • By Group ID curl -X POST http://localhost:3019/v0/cue-group-state/by-id
    -H "Content-Type: application/json"
    -d '{ "groupId1": "variantId1", "groupId2": "variantId2" }'
  • By Group Name curl -X POST http://localhost:3019/v0/cue-group-state/by-name
    -H "Content-Type: application/json"
    -d '{ "groupName1": "variantName1", "groupName2": "variantName2" }'

Reset All Cue Groups to Default Variants

  • By Group Name curl -X POST http://localhost:3019/v0/cue-group-state/by-name
    -H "Content-Type: application/json"
    -d '{}'
  • By Group ID curl -X POST http://localhost:3019/v0/cue-group-state/by-id
    -H "Content-Type: application/json"
    -d '{}'

Node Management

  • Shutdown Node curl -X POST 192.168.1.2:3017/v0/shutdown
  • Restart Node Services curl -X POST 192.168.1.2:3017/v0/restart