Override#
Methods#
PUT#
Set the Intensity, Red, Green, Blue levels for a fixture or group. Action will propagate to all controllers in a project.
PUT /api/override
Payload is a JSON object with the following attributes:
Attribute |
Value Type |
Description |
Value Example |
---|---|---|---|
|
string |
What the override should be applied to: |
|
|
integer |
Optional. Group, fixture, or space number depending on |
|
|
integer or string |
Optional. Either an integer (0-255) representing the intensity to set as part of override or the string |
|
|
Override Colour or string |
Optional. Specifies the colour to set as part of the override. Either an Override Colour or the string |
|
|
integer or string |
Optional. Either an integer (0-255) representing the temperature component to set as part of override or the string |
|
|
float |
Optional. Fade time to apply the override change, in seconds. |
|
|
string |
Optional. Crossfade path to use when applying the override: |
|
Override Colour#
The value of the colour
attribute in a PUT override request is a JSON object, specifying colour as either RGB or Hue/Saturation values.
RGB#
Colour as RGB for colour
in an override PUT request:
Attribute |
Value Type |
Description |
Value Example |
---|---|---|---|
|
integer or string |
Optional. Red component to set as part of override: 0-255, or a percentage (0-100) followed by the % sign. Red override will not be changed if this attribute isn’t provided. |
|
|
integer or string |
Optional. Green component to set as part of override: 0-255, or a percentage (0-100) followed by the % sign. Green override will not be changed if this attribute isn’t provided. |
|
|
integer or string |
Optional. Blue component to set as part of override: 0-255, or a percentage (0-100) followed by the % sign. Blue override will not be changed if this attribute isn’t provided. |
|
Hue/Saturation#
Colour as hue/saturation for colour
in an override PUT request:
Attribute |
Value Type |
Description |
Value Example |
---|---|---|---|
|
integer |
Hue component to set as part of override: 0-255. |
|
|
integer |
Saturation component to set as part of override: 0-255. |
|
Note
Both hue
and saturation
are required for the request to be valid.
Example Overrides#
Override group 1 to full intensity, using 0-255 values, and set colour to yellow:
{
"target": "group",
"num": "1",
"intensity": 255,
"colour": {
"red": 255,
"green": 255,
"blue": 0
}
}
Override fixture 1 to 50% intensity and green, using percentages:
{
"target": "fixture",
"num": 1,
"intensity": "50%",
"colour": {
"red": "0%",
"green": "100%",
"blue": "0%"
}
}
Override fixture 2 to 80% intensity and blue, using hue and saturation:
{
"target": "fixture",
"num": 2,
"intensity": "50%",
"colour": {
"hue": 200,
"saturation": 240
}
}
Override group 3 colour temperature of 44 with a fade time of 5 seconds:
{
"target": "group",
"num": 3,
"intensity": 255,
"temperature": 44,
"fade": 5.0
}
Snapshot the colour and intensity of all fixtures:
{
"target": "group",
"num": "0",
"intensity": "snapshot",
"colour": "snapshot"
}
DELETE#
Release any overrides on fixtures or groups. Action will propagate to all controllers in a project.
DELETE /api/override
Payload is a JSON object with the following attributes:
Attribute |
Value Type |
Description |
Value Example |
---|---|---|---|
|
string |
What the overrides should be cleared on: |
|
|
integer |
Optional. Group or fixture number, depending on |
|
|
float |
Optional. Fade time in which to release overrides, in seconds. |
|