?apikey=1234567890
Commands which does not require rundown to be loaded
| http://10.0.7.2:5656/api/v1/invokeTemplateFunction?playserver=OVERLAY&playchannel=1&playlayer=19&webplayout=19&function=myCustomTemplateFunction¶ms=Hello%20World | ||
| GET | v1.0.12 | Uses an invoke handler to call a function in a template. See required parameters in the example call above. JSON objects can be passed as params by urlEncoding stringified JSON. Search SPX Knowledge Base for more info with keyword 'invoke'. |
| http://10.0.7.2:5656/api/v1/directplayout | ||
| POST | v1.0.12 | Populate template and execute a play/continue/stop -command to it. Post request body example here as stringified JSON: {"casparServer": "OVERLAY", "casparChannel": "1", "casparLayer": "20", "webplayoutLayer": "20", "relativeTemplatePath": "/vendor/pack/template.html", "DataFields": [{field: "f0", value: "Lorem"},{field: "f1", value: "Ipsum"}]; "command": "play"} The casparServer refers to a named CasparCG connection in SPX configuration. |
| http://10.0.7.2:5656/api/v1/controlRundownItemByID?file=HelloWorld-project/My%20first%20rundown&item=1616702200909&command=play | ||
| GET | v1.1.0 | Play / stop an item from a known rundown. (Remember you can rename rundown items from SPX GUI) |
Utility API calls
| http://10.0.7.2:5656/api/v1/feedproxy?url=http://corsfeed.net&format=xml | ||
| GET | v1.0.14 | A proxy endpoint for passing feed data from CORS protected datasources. Implemented for SPX SocialPlayout Extension. |
| http://10.0.7.2:5656/api/v1/panic | ||
| GET | v1.1.0 | Force clear to all output layers without out-animations. (Note, this does NOT save on-air state of rundown items to false, so when UI is reloaded the items will show the state before panic was triggered.) This is to be used for emergency situations only and not as a normal STOP command substitute. |
| http://10.0.7.2:5656/api/v1/getprojects | ||
| GET | v1.1.1 | Returns projects as an array of strings. |
| http://10.0.7.2:5656/api/v1/getrundowns?project=HelloWorld-project | ||
| GET | v1.1.1 | Returns rundown names of a given project as an array of strings. |
| http://10.0.7.2:5656/api/v1/rundown/get | ||
| GET | v1.1.1 | Returns current rundown as json. |
| http://10.0.7.2:5656/api/v1/getlayerstate | ||
| GET | v1.1.1 | Returns current memory state of web-playout layers of the server (not UI). Please note, if API commands are used to load templates, this may not return them as expected! |
| http://10.0.7.2:5656/api/v1/version | ||
| GET | v1.1.2 | Returns SPX version info |
| http://10.0.7.2:5656/api/v1/gettemplates?project=HelloWorld-project | ||
| GET | v1.1.3 | Returns templates and their settings from a given project. |
| http://10.0.7.2:5656/api/v1/executeScript?file=open-calculator.bat | ||
| GET | v1.1.4 | Execute a shell script/batch file in ASSETS/scripts folder using a shell associated with a given file extension. |
Commands to load playlists, move focus on the opened rundown etc.
| http://10.0.7.2:5656/api/v1/rundown/load?file=MyFirstProject/MyFirstRundown | ||
| GET | 1.0 | Open rundown from project / file. |
| http://10.0.7.2:5656/api/v1/rundown/focusFirst | ||
| GET | 1.0 | Move focus to the first item on the rundown. |
| http://10.0.7.2:5656/api/v1/rundown/focusNext | ||
| GET | 1.0 | Move focus down to next item, will not circle back to top when end is reached. |
| http://10.0.7.2:5656/api/v1/rundown/focusPrevious | ||
| GET | 1.0 | Move focus up to previous item, will not circle back to bottom when top is reached. |
| http://10.0.7.2:5656/api/v1/rundown/focusLast | ||
| GET | 1.0 | Move focus to the last item on the rundown. |
| http://10.0.7.2:5656/api/v1/rundown/focusByID/1234567890 | ||
| GET | 1.0 | Move focus by ID on the rundown. |
| http://10.0.7.2:5656/api/v1/rundown/stopAllLayers | ||
| GET | 1.0 | Animate all layers (used by the current rundown) out, but does not clear layers. |
Commands for rundown items. API response is rundown reference, id of rundown item and it's current playout status and server info.
| http://10.0.7.2:5656/api/v1/item/play | ||
| GET | 1.0 | Start focused item. |
| http://10.0.7.2:5656/api/v1/item/play/1234567890 | ||
| GET | 1.0 | Start item by ID on the active rundown. |
| http://10.0.7.2:5656/api/v1/item/continue | ||
| GET | 1.0 | Issue continue command to selected item. Notice this needs support from the template itself and does not work as play or stop. |
| http://10.0.7.2:5656/api/v1/item/continue/1234567890 | ||
| GET | 1.0 | Continue to item by ID on the active rundown. Notice this needs support from the template itself and does not work as play or stop. |
| http://10.0.7.2:5656/api/v1/item/stop | ||
| GET | 1.0 | Stop focused item. |
| http://10.0.7.2:5656/api/v1/item/stop/1234567890 | ||
| GET | 1.0 | Stop item by ID on the active rundown. |