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
US
JP
US
JP
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaScript Suite Documentation
LightCapabilities

LightCapabilities Class Reference

Constructors

Instance Methods

Constructors

new LightCapabilities(parameters)

Initializes an instance of LightCapabilities.

Instance Methods

lightCapabilities.getDensityAvailable() ⇒ Boolean

Get the DensityAvailable

Kind: Instance method of LightCapabilities
Returns: Boolean - the KEY_DENSITY_AVAILABLE value

lightCapabilities.getNameParam() ⇒ LightName

Get the NameParam

Kind: Instance method of LightCapabilities
Returns: LightName - the KEY_NAME value

lightCapabilities.getRgbColorSpaceAvailable() ⇒ Boolean

Get the RgbColorSpaceAvailable

Kind: Instance method of LightCapabilities
Returns: Boolean - the KEY_RGB_COLOR_SPACE_AVAILABLE value

lightCapabilities.getStatusAvailable() ⇒ Boolean

Get the StatusAvailable

Kind: Instance method of LightCapabilities
Returns: Boolean - the KEY_STATUS_AVAILABLE value

lightCapabilities.setDensityAvailable(available) ⇒ LightCapabilities

Set the DensityAvailable

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

ParamTypeDescription
available Boolean Indicates if the light's density can be set remotely (similar to a dimmer). - The desired DensityAvailable.

lightCapabilities.setNameParam(name) ⇒ LightCapabilities

Set the NameParam

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

ParamTypeDescription
name LightName Enumeration that describes possible values of light name. The mobile libraries and SDL Core use the name string when referencing these elements. - The desired NameParam.

lightCapabilities.setRgbColorSpaceAvailable(available) ⇒ LightCapabilities

Set the RgbColorSpaceAvailable

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

ParamTypeDescription
available Boolean Indicates if the light's color can be set remotely by using the sRGB color space. - The desired RgbColorSpaceAvailable.

lightCapabilities.setStatusAvailable(available) ⇒ LightCapabilities

Set the StatusAvailable

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

ParamTypeDescription
available Boolean Indicates if the status (ON/OFF) can be set remotely. App shall not use read-only values (RAMP_UP/RAMP_DOWN/UNKNOWN/INVALID) in a setInteriorVehicleData request. - The desired StatusAvailable.
View on GitHub.com
Previous Section Next Section