Interface: AmbilightApi
Provides methods to interact with the Ambilight API, including brightness control, mode management, color configuration, and state retrieval.
Methods
decreaseBrightness()
decreaseBrightness():
Promise<void>
Decreases the Ambilight brightness by one step.
Returns
Promise<void>
getAmbiHue()
getAmbiHue():
Promise<AmbiHueState>
Returns the current AmbiHue (Philips Hue sync) power state.
Returns
Promise<AmbiHueState>
Throws
If the request fails.
getBrightnessInformation()
getBrightnessInformation():
Promise<MenuSettingValueInner>
Retrieves full brightness information including available choices and current value.
Returns
Promise<MenuSettingValueInner>
getBrightnessValue()
getBrightnessValue():
Promise<number>
Returns the current brightness value.
Returns
Promise<number>
getCachedState()
getCachedState():
Promise<AmbilightPixelData>
Retrieves the current cached Ambilight pixel state.
Returns
Promise<AmbilightPixelData>
The current pixel data.
Throws
If the request fails.
getConfiguration()
getConfiguration():
Promise<AmbilightCurrentConfiguration>
Retrieves the current Ambilight configuration from the API.
Returns
Promise<AmbilightCurrentConfiguration>
Throws
If the request fails.
getFullInformation()
getFullInformation():
Promise<GetFullAmbilightInformationResult>
Retrieves full Ambilight information including mode, brightness, and configuration.
Returns
Promise<GetFullAmbilightInformationResult>
getMode()
getMode():
Promise<AmbilightModeResponse>
Returns the current Ambilight mode.
Returns
Promise<AmbilightModeResponse>
increaseBrightness()
increaseBrightness():
Promise<void>
Increases the Ambilight brightness by one step.
Returns
Promise<void>
setBrightness()
setBrightness(
brightness):Promise<void>
Sets the Ambilight brightness to the given level.
Parameters
| Parameter | Type | Description |
|---|---|---|
brightness | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | The desired brightness level. |
Returns
Promise<void>
setCachedColor()
setCachedColor(
data):Promise<void>
Sends an RGB color to the Ambilight cached endpoint.
Parameters
| Parameter | Type | Description |
|---|---|---|
data | RGBColor | The RGB color to apply. |
Returns
Promise<void>
Throws
If the request fails.
setFollowAudioMode()
setFollowAudioMode(
mode):Promise<void>
Sets the Ambilight to Follow Audio mode.
Parameters
| Parameter | Type | Description |
|---|---|---|
mode | "ENERGY_ADAPTIVE_BRIGHTNESS" | "ENERGY_ADAPTIVE_COLORS" | "KNIGHT_RIDER_ALTERNATING" | "MODE_RANDOM" | "RANDOM_PIXEL_FLASH" | "SPECTRUM_ANALYSER" | "VU_METER" | "SPECTRUM_ANALYZER" | "KNIGHT_RIDER_CLOCKWISE" | "STROBO" | "PARTY" | The follow audio mode to apply. |
Returns
Promise<void>
Throws
If the provided mode fails schema validation.
setFollowVideoMode()
setFollowVideoMode(
mode):Promise<void>
Sets the Ambilight to Follow Video mode.
Parameters
| Parameter | Type | Description |
|---|---|---|
mode | "COMFORT" | "GAME" | "IMMERSIVE" | "NATURAL" | "RELAX" | "STANDARD" | "VIVID" | The follow video mode to apply. |
Returns
Promise<void>
Throws
If the provided mode fails schema validation.
setMode()
setMode(
mode):Promise<void>
Sets the Ambilight mode.
Parameters
| Parameter | Type | Description |
|---|---|---|
mode | "manual" | "internal" | "expert" | The Ambilight mode to apply. |
Returns
Promise<void>
setStaticColor()
setStaticColor(
hexColor,opt?):Promise<void>
Sets the Ambilight to a static color from a hex string.
Parameters
| Parameter | Type | Description |
|---|---|---|
hexColor | string | The target color as a hex string (e.g. #FF8800). |
opt? | { brightness: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10; } | Optional settings. If brightness is provided, it will be applied before setting the color. |
opt.brightness? | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | - |
Returns
Promise<void>
turnOff()
turnOff():
Promise<void>
Turns off the Ambilight.
Returns
Promise<void>