Browse docsoutput.set_lightbar

On this page

API method

`output.set_lightbar`

Sends a Remote Play lightbar command using one #RRGGBB/0xRRGGBB string (including rgb.* constants) or three 0 to 255 bytes.

Syntax

Atlas Script

output.set_lightbar(color_or_r, g?, b?)

Parameters

color_or_r: Either one Atlas RGB color value, or the red component when the separate green and blue arguments are also supplied.
g Optional: Green color component, normally in the documented byte range.
b Optional: Blue color component, normally in the documented byte range.

Return value

See the remarks for the returned value and runtime behavior.

Remarks

Sends a Remote Play lightbar command using one #RRGGBB/0xRRGGBB string (including rgb.* constants) or three 0 to 255 bytes. Literal color names and CSS-style rgb(...) strings are not parsed. The color latches until output.reset_lightbar; device support is required, non-Remote-Play hosts reject feedback.

Examples

Usage pattern

// Replace color_or_r, g, b with values described above.
output.set_lightbar(color_or_r, g, b);