|
FireSync API
|
Represents light configuration.
Public Member Functions | |
| kStatus | kLight_AddExtension (kLight light, kType type, kLightExt *extension) |
| Creates and adds a new light control extension of the specified type. More... | |
| kStatus | kLight_AddState (kLight light, kLightState *state) |
| Creates and adds a new state with default values. More... | |
| kStatus | kLight_Clear (kLight light, kSize stateCount) |
| Resets light mode settings to defaults. More... | |
| kStatus | kLight_ClearAll (kLight light, kSize stateCount) |
| Resets light mode and device settings to defaults. More... | |
| kLightControl | kLight_Control (kLight light) |
| Reports the light control mode. More... | |
| k32u | kLight_ControlId (kLight light) |
| Gets the control source id for a light. More... | |
| kStatus | kLight_ControlIdInfo (kLight light, kInfo *info) |
| Reports constraint and validity information for the ControlId setting. More... | |
| kStatus | kLight_ControlInfo (kLight light, kInfoBits *info) |
| Reports constraint and validity information for the Control setting. More... | |
| kLightCouplingMode | kLight_CouplingMode (kLight light) |
| Reports the light coupling mode. More... | |
| kStatus | kLight_CouplingModeInfo (kLight light, kInfoBits *info) |
| Reports constraint and validity information for the CouplingMode setting. More... | |
| kStatus | kLight_DeleteExtension (kLight light, kLightExt extension) |
| Destroys the specified light control extension and removes it from the light's extension list. More... | |
| kStatus | kLight_DeleteState (kLight light, kLightState state) |
| Destroys the specified state and removes it from the light's state list. More... | |
| kStatus | kLight_Enable (kLight light, kBool enable) |
| Enables or disables the light. More... | |
| kStatus | kLight_EnablePowerSaver (kLight light, kBool enabled) |
| Enables light power-saver mode. More... | |
| kLightExt | kLight_ExtensionAt (kLight light, kSize index) |
| Gets the control extension at the specified index. More... | |
| kSize | kLight_ExtensionCount (kLight light) |
| Gets the number of control extensions that have been configured. More... | |
| kSize | kLight_Id (kLight light) |
| Gets the id of the light module. More... | |
| k64f | kLight_Intensity (kLight light) |
| Gets the intensity associated with this light. More... | |
| kStatus | kLight_IntensityInfo (kLight light, kInfo64f *info) |
| Reports constraint and validity information for the Intensity setting. More... | |
| kBool | kLight_IsEnabled (kLight light) |
| Reports whether the light is currently enabled. More... | |
| kBool | kLight_IsLockedOut (kLight light) |
| Reports whether light lockout is currently in effect. More... | |
| kStatus | kLight_LockedOutInfo (kLight light, kInfoBool *info) |
| Reports constraint and validity information for the LockOut property. More... | |
| kStatus | kLight_LockOut (kLight light, kBool shouldLock) |
| Controls the light lockout state. More... | |
| kLightMask | kLight_Mask (kLight light) |
| Reports the light mask source type. More... | |
| k32u | kLight_MaskId (kLight light) |
| Gets the light mask source id. More... | |
| kStatus | kLight_MaskIdInfo (kLight light, kInfo *info) |
| Reports constraint and validity information for the MaskId setting. More... | |
| kStatus | kLight_MaskInfo (kLight light, kInfoBits *info) |
| Reports constraint and validity information for the Mask setting. More... | |
| kBool | kLight_MaskPolarity (kLight light) |
| Gets the light mask polarity. More... | |
| kStatus | kLight_MaskPolarityInfo (kLight light, kInfoBool *info) |
| Reports constraint and validity information for the MaskPolarity setting. More... | |
| k64f | kLight_MaxDutyCycle (kLight light) |
| Gets the maximum light duty cycle setting. More... | |
| kStatus | kLight_MaxDutyCycleInfo (kLight light, kInfo64f *info) |
| Reports constraint and validity information for the MaxDutyCycle setting. More... | |
| k64u | kLight_MinimumPeriod (kLight light) |
| Reports the time required by this light to respond to an event. More... | |
| kStatus | kLight_Override (kLight light, const kLightOverrideItem *overrides, kSize count) |
| Provides a list of configuration overrides to modify live light behaviour. More... | |
| kStatus | kLight_PowerEnabledSaverInfo (kLight light, kInfoBool *info) |
| Reports constraint and validity information for the PowerSaverEnabled property. More... | |
| kBool | kLight_PowerSaverEnabled (kLight light) |
| Reports whether power saver is currently enabled. More... | |
| kLightPrimingMode | kLight_PrimingMode (kLight light) |
| Reports the light priming mode. More... | |
| kStatus | kLight_PrimingModeInfo (kLight light, kInfoBits *info) |
| Reports constraint and validity information for the PrimingMode setting. More... | |
| kStatus | kLight_SetControl (kLight light, kLightControl type) |
| Sets the light control mode. More... | |
| kStatus | kLight_SetControlId (kLight light, k32u id) |
| Sets the control source id for a light. More... | |
| kStatus | kLight_SetCouplingMode (kLight light, kLightCouplingMode mode) |
| Sets the light coupling mode. More... | |
| kStatus | kLight_SetIntensity (kLight light, k64f intensity) |
| Sets intensity associated with this light. More... | |
| kStatus | kLight_SetMask (kLight light, kLightMask mask) |
| Sets the light mask source type. More... | |
| kStatus | kLight_SetMaskId (kLight light, k32u id) |
| Sets the light mask source id. More... | |
| kStatus | kLight_SetMaskPolarity (kLight light, kBool isActiveHigh) |
| Sets the light mask polarity. More... | |
| kStatus | kLight_SetMaxDutyCycle (kLight light, k64f dutyCycle) |
| Sets the maximum light duty cycle. More... | |
| kStatus | kLight_SetOutputState (kLight light, kBool state) |
| Sets output state of the light in SetBySoftware mode. More... | |
| kStatus | kLight_SetPrimingMode (kLight light, kLightPrimingMode mode) |
| Sets the light priming mode. More... | |
| kLightState | kLight_StateAt (kLight light, kSize index) |
| Gets the state at the specified index. More... | |
| kSize | kLight_StateCount (kLight light) |
| Gets the number of states belonging to the light. More... | |
| kStatus | kLight_StateCountInfo (kLight light, kInfoSize *info) |
| Reports constraint and validity information for the StateCount setting. More... | |
| kStatus | kLight_Stats (kLight light, kLightStats *stats) |
| Gets light statistics. More... | |
| kStatus | kLight_SwapStates (kLight light, kSize index0, kSize index1) |
| Swaps the order of two states in the light's state list. More... | |
| kStatus | kLight_Trigger (kLight light) |
| Provides a software trigger to a light. More... | |
