-
Viz Flowics
Graphics
Published by
Techtriq
-
Viz Flowics
Graphics
Viz Flowics is a visual content creation and management platform known for its versatility. It allows users to design, curate, and display visuals across digital channels. Flowics facilitates the integration of user-generated content, polls, and interactive graphics into live broadcasts and digital campaigns.
Offering a user-friendly interface for creating visuals, the platform is tailored for marketing professionals, broadcasters, and event organizers. Flowics also provides analytics to track audience engagement and assess the impact of visual content strategies.
Viz Flowics Output API
Show Output Info
Gets definition of a graphics output. Response fields | Key | Description | Type | | --- | --- | --- | | `id` | Graphics unique identifier | `string` | | `name` | Graphics name | `string` | | `controlUrl` | URL of the Graphics Control Interface | `string` | | `embeddableControlUrl` | URL of the Embedable Graphics Control Interface | `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` | ---
List Global Data Providers
GET /graphics/{graphicsToken}/control/global-providers-data Get global providers information from a graphics output. LIMITATION: Currently only Google Sheets and Timer Providers are listed. More will be available. Example response ``` json [ { "id": "n90", "title": "Google Sheets Provider", "type": "google-sheet-provider", "actions": { "sync": { "method": "PUT", "type": "http-action", "url": "https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control/global-data-providers/id:n90/actions/gs-sync" } } }, { "id": "n104", "title": "Google Sheets Provider", "type": "google-sheet-provider", "actions": {} }, { "id": "n105", "title": "Timer", "type": "timer-provider", "timer-mode": "timer", "controls": { "timer": { "id": "timer", "title": "my timer", "type": "timer", "value": { "startFrom": "05:00:00", "stopOn": "00:00:00", "current": "05:00:00", "state": "pause", "timeReference": 1676658474240, } } }, "actions": {} } ] ``` Response Fields | Key | Description | Type | | --- | --- | --- | | `/:i/id` | Global Data Provider identifier | `string` | | `/:i/integrationId` | Global Data Provider Integration Id. It is only present if an `Integration Id` was configured for this Global Data Provider | `string` | | `/:i/title` | Provider name | `string` | | `/:i/type` | Provider type | `string` | | `/:i/actions` | Provider actions | `object` | | `/:i/actions[actionType]` | Action parameters | `RequestAction` | Each provider type defines its own actions. Currently all action are of type \`http-action\`. Each action is described as an object that have the parameters for making an HTTP Request. _**Note: For executing and llisting actions, it is need to enabled the toggle in the edition of the graphic.**_ | Key | Description | Type | | --- | --- | --- | | `action.method` | Http method of the action | `GET` or `PUT` or `POST` | | `action.type` | Action Type | `http-action` | | `action.url` | Url of action | `string` | See [Global Data Providers Actions](#e25879ef-3893-4ad9-8ea2-219c1d04f207) for details on available actions for each Data Provider. Timer Provider Response The Timer provider has a field `timer-mode` that can be `timer` , `stopwatch` or `countdown`. Each Provider mode has its own controls definition. Example Timer Provider - "Timer" mode ``` json { "id": "n7", "integrationId": "n7Id", "title": "Timer", "type": "timer-provider", "controls": { "timer": { "id": "timer", "title": "Timer", "type": "timer", "value": { "startFrom": "00:05:00", "stopOn": "00:00:00", "state": "pause", "current": "00:05:00", "timeReference": 0 } } }, "timer-mode": "timer", "actions": { "play": { "type": "http-action", "method": "PUT", "url": "http://dev.flowics.com:5000/external/api/graphics/q4VXSCvlnZcbO8CXWnVo/control/global-data-providers/iid:n7Id/actions/play" }, "pause": { "type": "http-action", "method": "PUT", "url": "http://dev.flowics.com:5000/external/api/graphics/q4VXSCvlnZcbO8CXWnVo/control/global-data-providers/iid:n7Id/actions/pause" }, "reset": { "type": "http-action", "method": "PUT", "url": "http://dev.flowics.com:5000/external/api/graphics/q4VXSCvlnZcbO8CXWnVo/control/global-data-providers/iid:n7Id/actions/reset" }, "toggle": { "type": "http-action", "method": "PUT", "url": "http://dev.flowics.com:5000/external/api/graphics/q4VXSCvlnZcbO8CXWnVo/control/global-data-providers/iid:n7Id/actions/toggle" }, "resolveTime": { "type": "http-action", "method": "GET", "url": "http://dev.flowics.com:5000/external/api/graphics/q4VXSCvlnZcbO8CXWnVo/control/global-data-providers/iid:n7Id/actions/resolveTime" } }, } ``` Response "Timer" mode control fields | Key | Description | Type | | --- | --- | --- | | `controls/timer` | Controls of "Timer" mode | `object` | | `controls/timer/id` | Provider id | `string` | | `controls/timer/type` | Provider type | `string` | | `controls/timer/value` | Provider value | `object` | | `controls/timer/value/startFrom` | Start from value | `string` format `HH:mm:ss` | | `controls/timer/value/stopOn` | Stop on value | `string` format `HH:mm:ss` | | `controls/timer/value/current` | Time that is use as reference with the "timeReference" for calculating the real time of the provider. By default is the value of the startFrom attribute. | `string` format `HH:mm:ss` | | `controls/timer/value/state` | Current state | `play` or `pause` | | `controls/timer/value/timeReference` | Timestamp of last play/pause/toggle action | `timestamp` | "Timer" mode actions | Name | HTTP Method | Description | | --- | --- | --- | | `play` | `PUT` | Play the Timer Provider | | `pause` | `PUT` | Pause the Timer Provider | | `reset` | `PUT` | Set the current and timeReference to startFrom value | | `toggle` | `PUT` | Toggle the Timer Provider. If it Play, will set Pause. If it is Pause, will set Play | | `resolveTime` | `GET` | Get the resolved time of the Timer | Example Timer Provider - "Stopwatch" mode. ``` json { "id": "n8", "integrationId": "n8Id", "title": "Stopwatch", "type": "timer-provider", "timer-mode": "stopwatch", "controls": { "stopwatch": { "id": "stopwatch", "type": "stopwatch", "title": "Stopwatch", "value": { "startFrom": "00:00:00", "stopOn": "00:45:00", "state": "pause", "current": "00:00:00", "timeReference": 0 } } }, "actions": { "play": { "type": "http-action", "method": "PUT", "url": "http://dev.flowics.com:5000/external/api/graphics/q4VXSCvlnZcbO8CXWnVo/control/global-data-providers/iid:n8Id/actions/play" }, "pause": { "type": "http-action", "method": "PUT", "url": "http://dev.flowics.com:5000/external/api/graphics/q4VXSCvlnZcbO8CXWnVo/control/global-data-providers/iid:n8Id/actions/pause" }, "reset": { "type": "http-action", "method": "PUT", "url": "http://dev.flowics.com:5000/external/api/graphics/q4VXSCvlnZcbO8CXWnVo/control/global-data-providers/iid:n8Id/actions/reset" }, "toggle": { "type": "http-action", "method": "PUT", "url": "http://dev.flowics.com:5000/external/api/graphics/q4VXSCvlnZcbO8CXWnVo/control/global-data-providers/iid:n8Id/actions/toggle" }, "resolveTime": { "type": "http-action", "method": "GET", "url": "http://dev.flowics.com:5000/external/api/graphics/q4VXSCvlnZcbO8CXWnVo/control/global-data-providers/iid:n8Id/actions/resolveTime" } }, } ``` Response "Stopwatch" mode control fields | Key | Description | Type | | --- | --- | --- | | `controls/stopwatch` | Controls of "Stopwatch" mode. | `object` | | `controls/stopwatch/id` | Provider id | `string` | | `controls/stopwatch/type` | Provider type | `string` | | `controls/stopwatch/value` | Provider value | `object` | | `controls/stopwatch/value/startFrom` | Start from value | `string` format `HH:mm:ss` | | `controls/stopwatch/value/stopOn` | Stop on value | `string` format `HH:mm:ss` | | `controls/stopwatch/value/current` | Time that is use as reference with the "timeReference" for calculating the real time of the provider. By default is the value of the startFrom attribute. | `string` format `HH:mm:ss` | | `controls/stopwatch/value/state` | Current State | `play` or `pause` | | `controls/stopwatch/value/timeReference` | Timestamp of last play/pause/toggle action | `timestamp` | Stopwatch Actions | Name | HTTP Method | Description | | --- | --- | --- | | `play` | `PUT` | Play the Timer Provider | | `pause` | `PUT` | Pause the Timer Provider | | `reset` | `PUT` | Set the current and timeReference to startFrom value | | `toggle` | `PUT` | Toggle the Timer Provider. If it Play, will set Pause. If it is Pause, will set Play | | `resolveTime` | `GET` | Get the resolved Time of the Stopwatch | Example Timer Provider mode Countdown ``` json { "id": "n9", "integrationId": "n9Id", "title": "Countdown", "type": "timer-provider", "actions": {}, "timer-mode": "countdown", "controls": { "countdown": { "id": "countdown", "type": "countdown", "title": "Countdown to Date", "value": { "date": "01-11-2023", "time": "16:17:40", "timezone": "America/Buenos_Aires" } } } } ``` Response Countdown Control Fields | Key | Description | Type | | --- | --- | --- | | `controls/countdown` | Controls of "Countdown" mode | `object` | | `controls/countdown/id` | Provider id | `string` | | `controls/countdown/type` | Provider type | `string` | | `controls/countdown/value` | Provider value | `object` | | `controls/countdown/value/date` | Countdown date | `string` format `MM-DD-YYYY` | | `controls/countdown/value/time` | Countdown time | `string` format `HH:mm:ss` | | `controls/countdown/value/timezone` | Provider timezone | `string` |
Update Global Data Providers
PATCH /graphics/{graphicsToken}/control/global-providers-data Update global providers information from a graphics output. Request Example The request should be a JSON with an array of updates for different Global Providers. ``` json [ { "id": "n7", "controls": { "timer": { "value": { "startFrom": "00:06:00", }, }, }, } ] ``` Request fields | Field | Description | Required | Type | Valid Options | | --- | --- | --- | --- | --- | | `/id` | Id of the provider | (\*)yes | `string` | | | `/name` | Name of the provider | (\*)yes | `string` | | | `/integrationId` | IntegrationI ID of the Provider | (\*)yes | `string` | | | `/controls` | Describes controls for the provider. Each provider has its own controls definition. | no | `Controls` | | (\*) Only one of these is necessary. Timer Provider - "Timer" mode The "timer" mode allow to update the following controls | Field | Description | Required | Type | Valid Options | | --- | --- | --- | --- | --- | | `/controls/timer/value` | Controls object | no | `object` | | | `/controls/timer/value/startFrom` | Start from value | no | `string` format `HH:mm:ss` | | | `/controls/timer/value/stopOn` | Stop on value | no | `string` format `HH:mm:ss` | | | `/controls/timer/value/current` | Time that is used as reference with the "timeReference" for calculating the real time of the provider. By default is the value of the startFrom attribute. | no | `string` format `HH:mm:ss` | | | `/controls/timer/value/state` | Current state | no | `string` | `play` or `pause` | | `controls/timer/value/timeReference` | Timestamp of the last play/pause/toggle action | no | `timestamp` | | The "Timer" mode has the followings restrictions: - `startFrom` should be greater than `stopOn` - `stopOn` should be lower than `startFrom` - `current` should be lower or equal `startFrom` and greater or equal than `stopOn` - `startFrom`, `stopOn` and `current` maximun value is `23:59:59` and minimun value is `00:00:00` - `timeReference` should be a timestamp greater than 0. Update "Timer" mode request example ``` json [ { "id": "n7", "controls": { "timer": { "value": { "startFrom": "00:06:00", }, }, }, } ] ``` Timer Provider - "Stopwatch" mode The "Stopwatch" mode allow to update the following controls | Field | Description | Required | Type | Valid Options | | --- | --- | --- | --- | --- | | `/controls/stopwatch/value` | Controls object | no | `object` | | | `/controls/stopwatch/value/startFrom` | Start from value | no | `string` format `HH:mm:ss` | | | `/controls/stopwatch/value/stopOn` | Stop on value | no | `string` format `HH:mm:ss` | | | `/controls/stopwatch/value/current` | Time that is used as reference with the "timeReference" for calculating the real time of the provider. By default is the value of the startFrom attribute. | no | `string` format `HH:mm:ss` | | | `/controls/stopwatch/value/state` | Current state | no | `string` | `play` or `pause` | | `/controls/stopwatch/value/timeReference` | Timestamp of the last play/pause/toggle action | no | `timestamp` | | The "Stopwatch" mode has the followings restrictions: - `startFrom` should be lower than `stopOn` - `stopOn` should be greater than `startFrom` - `current` should be greater or equal `startFrom` and lower or equal than `stopOn` - `startFrom`, `stopOn` and `current` maximun value is `23:59:59` and minimun value is `00:00:00` - `timeReference` should be a timestamp greater than 0. Update "Stopwatch" mode request example ``` json [ { "id": "n9", "controls": { "stopwatch": { "value": { "startFrom": "00:06:00", }, }, }, }, ] ``` Timer Provider - "Countdown" mode The "Countdown" mode allows to update the following controls | Field | Description | Required | Type | Valid Options | | --- | --- | --- | --- | --- | | `/controls/countdown/value` | Controls object | no | `object` | | | `/controls/countdown/value/date` | Countdown date | no | `string` format `MM-DD-YYYY` | | | `/controls/stopwatch/value/time` | Countdonw time | no | `string` format `HH:mm:ss` | | Update "Countdown" mode request example ``` json [ { "id": "n8", "controls": { "countdown": { "value": { "date": "01-01-2023", "time": "17:00:00" }, }, }, }, ] ```
List Overlays
List overlays information from a graphics output. Response fields | Key | Description | Type | | --- | --- | --- | | `/:i/id` | Overlay identifier | `string` | | `/:i/name` | Overlay name | `string` | | `/:i/integrationId` | Overlay integration id. It is only present if an `Integration Id` was configured for this overlay | `string` | | `/:i/state` | Overlay status | `in` or `out` | | `/:i/region` | Region where Overlay is located | `object` | | `/:i/region/id` | Region identifier | `string` | | `/:i/region/name` | Region name | `string` | | `/:i/region/scene` | Scene where Region is located | `object` | | `/:i/region/scene/id` | Scene identifier | `string` | | `/:i/region/scene/name` | Scene name | `string` | | `/:i/region/scene/state` | Scene status | `in` or `out` | | `/:i/controls` | Describes controls for the Overlay. | object whose keys are control identifiers (see `/:i/controls/:j/id`) | | `/:i/controls/:j/id` | Control identifier. This value is specified in the graphics package editor when configuring a property (such as Text node's text) to be controllable. | `string` | | `/:i/controls/:j/type` | Control type. Possible values: `text`, `image` | `string` | | `/:i/controls/:j/title` | Control title | `string` | | `/:i/controls/:j/value` | Control value. The value depends on the type of control. See description below. | `object` or `string` | | `/:i/controls/:j/order` | Specifies a suggested order of this control relative to other controls on this overlay. May be used by client applications to order the overlay controls when displayed to its users. | number | _Control value object_ can have different types depending on the type of control: - If the control type is `text`, the value can be a `string`. - If the control type is `image`, the value can be either: - `{ "type": "url", "url": string }`, if an image is present. The \`url \` property is an URL - `{ "type": "empty" }`, if no image is present.
Update Overlays
Partially updates overlays. With this endpoint, one or more overlays can be modified. Updates can comprise either overlay state ( `IN` | `OUT`), overlay controls, or both. For overlay state change same rules as in [Overlay State Transition](#f16a4eb7-625c-4af7-9ef9-bf57e55253ad) apply. Request fields | **Key** | **Description** | **Type** | **Required** | | --- | --- | --- | --- | | `/:i/id` | Overlay identifier | `string` | Either `/:i/id` or `/:i/integrationId` has to be specified to identify an overlay | | `/:i/integrationId` | Overlay Integration Id | `string` | See `/:i/id` | | `/:i/state` | Overlay status | `in` or `out` | No | | `/:i/controls/:controlId/value` | Control value for control with id `:controlId`. Depends on the type of control. See description below | `object` or `string` | No | Control value can vary depending on the type of control: - If the control type is `text`, the value can be a `string`. - If the control type is `image`, the value can be either: - `{ "type": "url", "url": string }`, if an image is present. The \`url \` must be a valid URL - `{ "type": "empty" }`, if no image is present.
Take All Overlays Out
Use it when you need to transition all overlays from a graphics output to OUT state.
Overlay State Transition
Transition overlay state 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. The transitions object must have the id of the node, and the requested transition, which could be **in**, **out** or **toggle**. Request fields | **Key** | **Description** | **Type** | **Required** | | --- | --- | --- | --- | | `/:i/id` | Overlay identifier | `string` | Either `/:i/id` or `/:i/integrationId` has to be specified to identify an overlay | | `/:i/integrationId` | Overlay Integration Id | `string` | See `/:i/id` | | `/:i/transition` | Overlay status | `in`, `out` or `toggle` | Yes |
Viz Flowics Playlists API
List Playlists
Get the Playlists of the remote Response fields | Field | Description | Type | | --- | --- | --- | | `/playlists` | An Array of playlists | `Playlist` | | `/playlists/:i/id` | The id of the Playlist _i_ | `string` | | `/playlists/:i/name` | The name of the playlist _i_ | `string` | | `/playlists/:i/controlMode` | Refers to the way the playlist can be controlled in the Rundown Control interface. `restricted` means the only actions allowed are sending overlays in or out and changing controls values. Create, remove or update items are not allowed. `unrestricted` means that every operation is allowed. | `string` | | `/paging` | Paging description | `PagingObject` | | Key | Description | Type | | --- | --- | --- | | `/paging/cursors` | Description of cursors | `CursorObj` | | `/paging/cursors/after` | After cursor | `string` | | `/paging/next` | Url to the next page | `string` | Query Params | Key | Description | Type | | --- | --- | --- | | `size` | Page size | `number` |
Create Playlists
Creates one or more playlists, appending them at the end of the list. Playlists can have repeated names. It's up to the client to specify different names if needed. Request Fields | Key | Description | Type | Required | | --- | --- | --- | --- | | `/:i/name` | Playlist name | `string` | Yes | | `/:i/controlMode` | Refers to the way the playlist can be controlled in the Rundown Control interface. `restricted` means the only actions allowed are sending overlays in or out and changing controls values. Create, remove or update items are not allowed. `unrestricted` means that every operation is allowed. | `string` | Optional. Default value is `unrestricted` | --- Response Fields | Key | Description | Type | | --- | --- | --- | | `/:i/id` | Playlist unique identifier | `string` | | `/:i/name` | Playlist name | `string` | | `/:i/controlMode` | Playlist Control mode | `restricted` or `unrestricted` | ---
Move Playlist
Set playlist positions in reference to another item Playlists can be moved to the first place or after another playlist. Request fields | Key | Description | Required | Type | Valid Options | | --- | --- | --- | --- | --- | | `/source` | List of playlist Ids to move | yes | `Array` | | | `/target` | Target description | yes | `TargetObj` | | | `/target/type` | Target type | yes | `string` | `first`, `after` | | `/target/afterId` | Id of target playlist. | Required when `/target/type` is `after` | `string` | |
Update Playlist
Edit playlist information. Request Fields | Key | Description | Type | Required | | --- | --- | --- | --- | | `name` | Playlist name | `string` | Optional | | `controlMode` | Refers to the way the playlist can be controlled in the Rundown Control interface. `restricted` means the only actions allowed are sending overlays in or out and changing controls values. Create, remove or update items are not allowed. `unrestricted` means that every operation is allowed. | `string` | Optional | One of the keys (`name` or `controlMode`) is required.
Delete Playlist
Deletes a Playlist. _Note:_ All the items belonging to the playlist will be taken out if needed and removed.
List Playlist Items
Get the items of a Playlist Response fields | Key | Description | Type | | --- | --- | --- | | `/items` | Array of Playlist Items | `PlaylistItem` | | `/items/:i/id` | Item unique identifier | `string` | | `/items/:i/name` | Item name | `string` | | `/items/:i/state` | Status of the Item | `'in' or 'out'` | | `/items/:i/overlayTemplate` | Id of the overlay template this instance is based on | `string` | | `/items/:i/controls` | Describes controls for the Overlay. An object whose keys are the control identifiers and the values are an object with a property `value`. | `object` | | `/items/:i/controls/:controlId` | Defines the properties of an overlay control | `object` | | `/items/:i/controls/:controlId/value` | Value of control. The type of the value depends on the type of the control. For now only text and image controls are supported. _See notes below._ | `string` or `object` | | `/paging` | Paging description. _See notes below._ | `object` | **Note:** `/items/:i/controls/:controlId/value` _Control value type_ can have different types depending on the type of control: - If the control type is `text`, the value can be a `string`. - If the control type is `image`, the value can be either: - `{ "type": "url", "url": string }`, if an image is present. The \`url \` property is a URL - `{ "type": "empty" }`, if no image is present. **Note:** `/paging` | Key | Description | Type | | --- | --- | --- | | /paging/cursors | Description of cursors | CursorObj | | /paging/cursors/after | After cursor | string | | /paging/next | Url to the next page | string | Query Params | Key | Description | Type | | --- | --- | --- | | `size` | Page size | `number` |
Create Playlist Items
Creates one or more Playlist Items. Playlist Items are based on Overlay Templates. To list the available overlay templates on a Graphics Package, see [List Overlays](#4e704e74-4237-4a47-8418-5c6f0e27e8e2). Please check the [Graphics Output API](#75fc120f-a3ca-48ba-aca0-754e0834cccd) documentation for details Request fields | Field | Description | Required | Type | | --- | --- | --- | --- | | `/:i/name` | Item name | yes | `string` | | `/:i/type` | Item Type. The only value allowed is `overlayInstance` | yes | `string` | | `/:i/overlayTemplate` | Overlay Template Id | Either `/:i/overlayTemplate` or `/:i/overlayTemplateIntegrationId` must be specified | `string` | | `/:i/overlayTemplateIntegrationId` | Overlay Template IntegrationId | Either `/:i/overlayTemplate` or `/:i/overlayTemplateIntegrationId` must be specified | `string` | | `/:i/controls` | Describes controls for the Overlay. Controls (object whose keys are control identifiers (see \`/:i/controls/:controlId\`) | no | `object` | | `/:i/controls/:controlId` | Defines the properties of an overlay control Control. The control id (\`:controlId\`) must match with one of the control Ids of the overlay template | no | `object` | | `/:i/controls/:controlId/value` | Control value. The value depends on the type of control. See description below. | no |`object` or `string`| _Control value object_ can have different types depending on the type of control: - If the control type is `text`, the value can be a `string`. - If the control type is `image`, the value can be either: - `{ "type": "url", "url": string }`, if an image is present. The \`url \` property is an URL - `{ "type": "empty" }`, if no image is present.
Update Playlist Items
Updates Playlist Items in bulk. It supports updating the state of each overlay ( `in` or `out`) and also updating the controls. Up to 100 items can be updated per request. Multiple overlay items can be transitioned in the same request by changing its state 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. Request fields | Field | Description | Required | Type | | --- | --- | --- | --- | | `/:i/name` | Item name | no | `string` | | `/:i/state` | Item State | no | `in` or `out` | | `/:i/controls` | Describes controls for the Overlay. Controls (object whose keys are control identifiers (see \`/:i/controls/:controlId\`) | no | `Controls` | | `/:i/controls/:controlId` <br> | Defines the properties of an overlay control Control. The control id (\`:controlId\`) must match with one of the control Ids of the overlay template | no | `Control` | | `/controls/:controlId/value` | Value of control. The type of the value depends on the type of the control. For now only text and image controls are supported. See description below. | No | `object` | **Note:** `/controls/:controlId/value` Can have different types depending on the type of control: - If the control type is `text`, the value can be a `string`. - If the control type is `image`, the value can be either: - { "type": "url", "url": string }, if an image is present. The `url` property must be a valid URL. - { "type": "empty" }, if no image is present.
Move Playlist Item
Set Items positions in reference to another item Items can be moved to the first place or after another Item. Request fields | Key | Description | Required | Type | Valid Options | | --- | --- | --- | --- | --- | | `/source` | List of item Ids to move | yes | `Array` | | | `/target` | Target description | yes | `TargetObj` | | | `/target/type` | Target type | yes | `string` | `first`, `after` | | `/target/afterId` | Id of target playlist item. | Required when `/target/type` is `after` | `string` | |
Update Playlist Item
Updates a Playlist Item. It supports updating the state of the overlay (\`in\` or `` out` ``) and also updating the controls. Request fields | Field | Description | Required | Type | | --- | --- | --- | --- | | `/name` | Item name | no | `string` | | `/state` | Item State | no | `in` or `out` | | `/controls` | Describes controls for the Overlay. Controls (object whose keys are control identifiers (see \`/controls/:controlId\`) | no | `object` | | `/controls/:controlId` | Defines the properties of an overlay control Control. The control id (\`:controlId\`) must match with one of the control Ids of the overlay template | no | `object` | | `/controls/:controlId/value` | Value of control. The type of the value depends on the type of the control. For now only text and image controls are supported. See description below. | No | `object` | **Note:** `/controls/:controlId/value` Can have different types depending on the type of control: - If the control type is `text`, the value can be a `string`. - If the control type is `image`, the value can be either: - { "type": "url", "url": string }, if an image is present. The `url` property must be a valid URL. - { "type": "empty" }, if no image is present.
Delete Playlist Item
Delete a Playlist Item. Takes the overlay out if needed.
Viz Flowics Global Data Providers Actions APIs
Sync
Allows you to sync Google Sheet data. Example Listing ``` json "sync": { "method": "PUT", "type": "http-action", "url": "https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control/global-data-providers/id:n90/actions/gs-sync" } ``` Rate Limit Currently this operation is rate-limited at 1 request per minute per IP. This operation is backed by a Google Cloud API, which is rate limited. For that reason, this action is intended to be called as a response to a manual sync operation triggered by a user and not as a high frequency action.
Pause
Allows you to change the state of a "Timer" or "Stopwatch" mode to _pause_. Example Listing ``` json "pause": { "method": "PUT", "type": "http-action", "url": "https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control/global-data-providers/id:n90/actions/pause" } ```
Play
Allows you to change the state of a "Timer" or "Stopwatch" mode to _play_. Example Listing ``` json "play": { "method": "PUT", "type": "http-action", "url": "https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control/global-data-providers/id:n90/actions/play" } ```
Reset
Allows you to _reset_ the state of a "Timer" or "Stopwatch" mode. Example Listing ``` json "reset": { "method": "PUT", "type": "http-action", "url": "https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control/global-data-providers/id:n90/actions/reset" } ```
Resolve
Allows you to get the resolved Time of a Timer Provider set in "Timer" or "Stopwatch" mode. In the information of the "Timer" or "Stopwatch" mode you will find the attributes "current" and "timeReference". While "timeReference" is the timestamp of the last play/pause/toggle action, the "current" attribute is the calculated formatted time in that timeRefernce. If you don’t trigger any play/pause/toggle action, “timeReference” and “current” values won’t change between 2 list global providers requests. The "resolveTime" endpoint exists in order to get the "current" formatted time at the time it was done the request. The answer is an object with four attributes: "current", "timeReference", "currentCalculated" and "timeReferenceCalculated". The "timeReferenceCalculated" is the request's timestamp. The "currentCalculated" is the time calculated at the timestamp of the request taking the "current" and "timeReference" values as parameters for the calculation. Example Listing ``` json "resolveTime": { "method": "GET", "type": "http-action", "url": "https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control/global-data-providers/id:n90/actions/resolveTime" } ``` Example Response ``` json { "current": "00:00:00", "currentCalculated": "00:00:01", "timeReference": 1676659739484, "timeReferenceCalculated": 1676659740549 } ``` | Key | Description | Type | | --- | --- | --- | | `current` | Current formatted time at the last play/pause/toggle action | `string` format `HH:mm:ss` | | `currentCalculated` | Current formatted time at the moment of the request using \`timeReferenceCalculated\` as time reference. | `string` format `HH:mm:ss` | | `timeReference` | Timestamp of the last play/pause/toggle action. | `timestamp` | | `timeReferenceCalculated` | Timestamp of the action. | `timestamp` |
Toggle
Allows you to change the state of a "Timer" or "Stopwatch" mode to _play_ if the state is _pause_ or to _pause_ if the state is _play_. Example Listing ``` json "toggle": { "method": "PUT", "type": "http-action", "url": "https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control/global-data-providers/id:n90/actions/toggle" } ```
This item is available for early access. It is still in development and may contain experimental features or limitations.
4 months ago