Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
LightState

LightState Class Reference

Constructors

Instance Methods

Constructors

new LightState(parameters)

Initalizes an instance of LightState.

Instance Methods

lightState.getColor() ⇒ RGBColor

Get the Color

Kind: Instance method of LightState
Returns: RGBColor - the KEY_COLOR value

lightState.getDensity() ⇒ Number

Get the Density

Kind: Instance method of LightState
Returns: Number - the KEY_DENSITY value

lightState.getIdParam() ⇒ LightName

Get the IdParam

Kind: Instance method of LightState
Returns: LightName - the KEY_ID value

lightState.getStatus() ⇒ LightStatus

Get the Status

Kind: Instance method of LightState
Returns: LightStatus - the KEY_STATUS value

lightState.setColor(color) ⇒ LightState

Set the Color

Kind: Instance method of LightState
Returns: LightState - The class instance for method chaining.

ParamTypeDescription
color RGBColor The desired Color.

lightState.setDensity(density) ⇒ LightState

Set the Density

Kind: Instance method of LightState
Returns: LightState - The class instance for method chaining.

ParamTypeDescription
density Number The desired Density. {'num_min_value': 0.0, 'num_max_value': 1.0}

lightState.setIdParam(id) ⇒ LightState

Set the IdParam

Kind: Instance method of LightState
Returns: LightState - The class instance for method chaining.

ParamTypeDescription
id LightName The name of a light or a group of lights. - The desired IdParam.

lightState.setStatus(status) ⇒ LightState

Set the Status

Kind: Instance method of LightState
Returns: LightState - The class instance for method chaining.

ParamTypeDescription
status LightStatus The desired Status.
View on GitHub.com
Previous Section Next Section