Falcon Play API
Falcon Play exposes HTTP API endpoints for status, media control, vision mixer control, functions, inputs, scenes, and rundown automation. The API is intended for automation, integrations, panels, and remote control systems.
Screenshot is coming soon...
What you will learn
- Which API groups exist.
- How to think about live-control endpoints.
- Where API actions map to Director concepts.
Recommended workflow
- Authenticate according to the public API documentation.
- Start with GET /api/status to confirm system readiness.
- Use read endpoints to discover inputs, functions, scenes, videos, and mixer configuration.
- Use POST endpoints only when the integration intentionally controls live output.
- Handle errors and offline states in the calling system.
Buttons, fields, and controls
| Control | What it does | When to use it |
|---|---|---|
| GET /api/status | Returns system status. | Use for health checks. |
| GET /api/machine-id | Returns machine identifier. | Use for support and registration. |
| GET /api/machine-info | Returns machine information. | Use for diagnostics. |
| GET /api/media/videos | Lists videos. | Use to build remote media selectors. |
| POST /api/media/play | Plays media. | Use for remote playout control. |
| POST /api/media/load | Loads media. | Use to prepare media. |
| POST /api/media/stop | Stops media. | Use to end playback. |
| POST /api/media/clear | Clears media output. | Use to reset playout channel. |
| POST /api/visionMixer/onAir | Takes a source to Program. | Use for external switching control. |
| POST /api/visionMixer/preview | Loads a source to Preview. | Use before taking live. |
| GET /api/visionMixer/inputs | Lists mixer inputs. | Use to populate control panels. |
| GET /api/visionMixer/config | Returns mixer configuration. | Use for integration setup. |
| POST /api/function/run | Runs a Falcon function. | Use for automation triggers. |
| GET /api/inputs | Lists configured inputs. | Use for source discovery. |
| GET /api/functions | Lists functions. | Use for automation menus. |
| GET /api/scenes | Lists scenes. | Use for graphics control panels. |
| POST /api/scene/play | Plays a scene. | Use for remote graphics control. |
| POST /api/scene/stop | Stops a scene. | Use to remove a graphic. |
| POST /api/scene/clear | Clears scene output. | Use for reset operations. |
| POST /api/rundown/take | Takes the next rundown item. | Use for remote next control. |
| POST /api/rundown/move-next-forward | Moves next cue forward. | Use for remote cue navigation. |
| POST /api/rundown/move-next-backward | Moves next cue backward. | Use for remote cue navigation. |
| POST /api/visionMixer/dsk/on/off/source | Controls downstream keyers. | Use for overlay automation. |
| POST /api/visionMixer/upstream/on/off/source | Controls upstream keyers. | Use for keyer automation. |
Best practices
- Always read status before sending live-control commands.
- Build confirmation UI around endpoints that affect Program output.
- Log every external automation call during production.
Troubleshooting
| Symptom | Likely cause | What to check |
|---|---|---|
| API call times out | Play Server is unavailable or network path is blocked. | Check server status and base URL. |
| Command succeeds but output does not change | Target subsystem is offline. | Check Vision Mixer, Media Server, Graphics Server, or Sound Mixer status. |
| Wrong item/source is affected | Payload references the wrong ID/name/server. | Fetch current lists before sending commands. |
Screenshot is coming soon...