| API Function | Description | Result |
|---|---|---|
| Channels APIs | ||
|
getChannelsValues
Universe index:
DMX start address:
Channels count:
|
Retrieve the specified number of DMX values for the given universe, starting at the given address. Note that indices start from 1 and not from 0. | |
| Function APIs | ||
getFunctionsNumber |
Retrieve the number of functions loaded | |
getFunctionsList |
Retrieve the list of functions with their ID and name | |
|
getFunctionType
Function ID:
|
Retrieve the type of a function with the given ID | |
|
getFunctionStatus
Function ID:
|
Retrieve the status of a function with the given ID. Possible values are "Running", "Stopped" and "Undefined" | |
| Virtual Console Widget APIs | ||
getWidgetsNumber |
Retrieve the number of widgets loaded | |
getWidgetsList |
Retrieve the list of Virtual Console Widgets with their ID and name | |
|
getWidgetType
Widget ID:
|
Retrieve the type of a Virtual Console Widget with the given ID | |
|
getWidgetStatus
Widget ID:
|
Retrieve the status of a Virtual Console Widget with the given ID | |
| High rate APIs | ||
| Due to the nature of some type of transmissions (for example a slider changing rapidly),
there are a few WebSocket operations stripped down to avoid useless overhead of data. So, instead of transmitting every time the "QLC+API|API name" information, direct calls are here used to accomplish fast operations. |
||
|
Simple Desk channel set
Absolute DMX address:
Value:
|
This API sets the value of a single channel of the QLC+ Simple Desk. The parameters to send are: Absolute DMX address: this is the address of the DMX channel you want to set. It is absolute in the sense that the universe information is implicit in the address itself. So for example addresses on the first universe will range from 1 to 512, while addresses on the second universe will range from 513 to 1024, and so on. Value: the value of the DMX channel to set in a range from 0 to 255. |
|
|
Basic widget value set
Widget ID:
Value:
|
This API is the direct way to set a Virtual Console widget value. It can be used for Buttons, Sliders and Audio Triggers. The value to set depends on the widget type itself. Buttons and Audio triggers will only support values 0 (= off) and 255 (= on) while Sliders will accept all the values in the 0-255 range. | |
|
Cue list control
Cue List ID:
Operation:
Step (optional):
|
This API demonstrates how to control a Virtual Console Cue List widget. The parameters to be used are: Cue List ID: The Cue List widget ID as retrieved with the 'getWidgetsList' API Operation: The Cue List operation to perform. Possible values are 'PLAY', 'NEXT', 'PREV' and 'STEP'. Only the 'STEP' operation requires a third parameter. The 'PLAY' operation will stop the Cue List if called twice. Step: The Cue List step index to play. Index starts from 0. |
|
|
Multipage frame control
Frame ID:
Operation:
|
This API demonstrates how to change page of a Virtual Console Frame widget in multipage mode.
The parameters to be used are: Frame ID: The Frame widget ID as retrieved with the 'getWidgetsList' API Operation: The Frame operation to perform. Accepted values are 'NEXT_PG' and 'PREV_PG'. |
|