This API provides the ability to control the transitions of overlays in a Graphics Package output.
In order to use this API, you'll need to generate a token for the Graphics Package you want to control. See this article for instructions.
API Reference
GET /graphics/{graphicsToken}/control
Gets information of a Graphics Package output.
Endpoint URL
https://api.flowics.com/graphics/{graphicsToken}/control
Example requests
curl https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control
Example response
{ "id": "5f651ecb600cdfec4d4b0148", "name": "Late Night News Graphics", "controlUrl": "https://viz.flowics.com/control/10387/viz/5f651ecb600cdfec4d4b0148", "embeddableControlUrl": "https://viz.flowics.com/control/10387/viz/5f651ecb600cdfec4d4b0148", "editorUrl": "https://viz.flowics.com/visualizations/10387/5f651ecb600cdfec4d4b0148/edit", "outputUrl": "https://viz.flowics.com/public/b0a621640be089b04dd04f3914f8b8c7/5f651e56600cdf96c64b0147/live", "experienceId": 10387, "updateAvailable": true }
Response fields
Key | Description | Type |
---|---|---|
id | Graphics unique identifier | string |
name | Graphics name | string |
controlUrl | URL of the Graphics Control | string |
embeddableControlUrl | URL of the Embedable Graphics Control |
string |
editorUrl | URL of the graphics editor | string |
outputUrl | URL of the graphics output | string |
experienceId | Experience unique identifier | number |
updateAvailable | If the graphics has new published changes or not. | boolean |
GET /graphics/{graphicsToken}/control/overlays
Gets overlays information from a graphics output.
Endpoint URL
https://api.flowics.com/graphics/{graphicsToken}/control/overlays
Example requests
curl https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control/overlays
Example responses
[ { "id":"n29", "name":"News", "state":"in", "region":{ "id":"n3", "name":"Center", "scene":{ "id":"s1", "name":"Scene s1", "state":"out" } } }, { "id":"n11", "name":"Timer", "state":"in", "region":{ "id":"n4", "name":"Lower Third", "scene":{ "id":"s1", "name":"Scene s1", "state":"out" } } }, { "id":"n7", "name":"Last news title", "state":"out", "region":{ "id":"n4", "name":"Lower Third", "scene":{ "id":"s1", "name":"Scene s1", "state":"out" } } } ]
Response fields
Key | Description | Type |
---|---|---|
id | Node unique identifier | string |
name | Node name | string |
state | Status of the node | in|out |
PUT /graphics/{graphicsToken}/control/overlays/take-all-out
Use it when you need to transition all overlays from a graphics output to OUT state.
Endpoint URL
https://api.flowics.com/graphics/{graphicsToken}/control/overlays/take-all-out
Example requests
curl -X PUT https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control/overlays/take-all-out
PUT /graphics/{graphicsToken}/overlays/transition
Transition overlays from a graphics output.
When doing an 'IN' transition to an overlay whose scene is 'OUT', that scene will automatically transition to 'IN'.
Multiple overlays can be transitioned in the same request with the following restrictions:
- Only one overlay per region is allowed to be transitioned to IN state.
- Only transitions from overlays in the same scene are allowed.
Endpoint URL
https://api.flowics.com/graphics/{graphicsToken}/control/overlays/transition
Example request for Windows
curl -H "Content-Type: application/json" -X PUT -d "["{\"id\":\"n9\",\"transition\":\"out\"}"]" https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control/overlays/transition
Example request for Linux
curl -H "Content-Type: application/json" -X PUT -d '[ { "id":"n29", "transition":"out" } ]' https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control/overlays/transition
The transitions object must have the id of the node, and the requested transition, which could be in, out or toggle.
Response statuses
HTTP status codes are used to indicate success and error. In case an error occurred a JSON body will be returned with more details. For example:
{ "code": 1404, "flags": 404, "defaultMessage": "Graphics Token was not found.", }
Error Response fields
Key | Description | Type |
---|---|---|
code | Error unique identifier | number |
flags | HTTP status code | number |
defaultMessage | Description of the error | string |