FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kLight.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_LIGHT_H
9 #define K_FIRESYNC_LIGHT_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
21 //typedef kObject kLight; --forward-declared in kFsDef.x.h
22 
23 
33 kFsFx(kSize) kLight_Id(kLight light);
34 
43 kFsFx(kStatus) kLight_Clear(kLight light, kSize stateCount);
44 
53 kFsFx(kStatus) kLight_ClearAll(kLight light, kSize stateCount);
54 
66 kFsFx(kStatus) kLight_Enable(kLight light, kBool enable);
67 
75 kFsFx(kBool) kLight_IsEnabled(kLight light);
76 
88 kFsFx(kStatus) kLight_SetControl(kLight light, kLightControl type);
89 
97 kFsFx(kLightControl) kLight_Control(kLight light);
98 
107 kFsFx(kStatus) kLight_ControlInfo(kLight light, kInfoBits* info);
108 
120 kFsFx(kStatus) kLight_SetControlId(kLight light, k32u id);
121 
129 kFsFx(k32u) kLight_ControlId(kLight light);
130 
139 kFsFx(kStatus) kLight_ControlIdInfo(kLight light, kInfo* info);
140 
156 kFsFx(kStatus) kLight_EnablePowerSaver(kLight light, kBool enabled);
157 
166 
176 
185 kFsFx(kStatus) kLight_LockOut(kLight light, kBool shouldLock);
186 
194 kFsFx(kBool) kLight_IsLockedOut(kLight light);
195 
204 kFsFx(kStatus) kLight_LockedOutInfo(kLight light, kInfoBool* info);
205 
216 kFsFx(kStatus) kLight_AddState(kLight light, kLightState* state);
217 
226 kFsFx(kStatus) kLight_DeleteState(kLight light, kLightState state);
227 
237 kFsFx(kStatus) kLight_SwapStates(kLight light, kSize index0, kSize index1);
238 
246 kFsFx(kSize) kLight_StateCount(kLight light);
247 
256 kFsFx(kStatus) kLight_StateCountInfo(kLight light, kInfoSize* info);
257 
266 kFsFx(kLightState) kLight_StateAt(kLight light, kSize index);
267 
279 kFsFx(kStatus) kLight_AddExtension(kLight light, kType type, kLightExt* extension);
280 
289 kFsFx(kStatus) kLight_DeleteExtension(kLight light, kLightExt extension);
290 
298 kFsFx(kSize) kLight_ExtensionCount(kLight light);
299 
308 kFsFx(kLightExt) kLight_ExtensionAt(kLight light, kSize index);
309 
319 kFsFx(k64u) kLight_MinimumPeriod(kLight light);
320 
329 kFsFx(kStatus) kLight_SetOutputState(kLight light, kBool state);
330 
339 kFsFx(kStatus) kLight_Stats(kLight light, kLightStats* stats);
340 
348 kFsFx(kStatus) kLight_Trigger(kLight light);
349 
364 kFsFx(kStatus) kLight_Override(kLight light, const kLightOverrideItem* overrides, kSize count);
365 
366 kEndHeader()
367 
368 #include <kFireSync/Client/kLight.x.h>
369 
370 #endif
kSize kLight_Id(kLight light)
Gets the id of the light module.
kStatus kLight_SetOutputState(kLight light, kBool state)
Sets output state.
kStatus kLight_SwapStates(kLight light, kSize index0, kSize index1)
Swaps the order of two states in the light's state list.
kStatus kLight_Trigger(kLight light)
Provides a software trigger to a light.
Represents light override item.
Definition: kNodeDef.h:786
kStatus kLight_StateCountInfo(kLight light, kInfoSize *info)
Reports constraint and validity information for the StateCount setting.
kStatus kLight_AddExtension(kLight light, kType type, kLightExt *extension)
Creates and adds a new light control extension of the specified type.
k64u kLight_MinimumPeriod(kLight light)
Reports the time required by this light to respond to an event.
kStatus kLight_ControlIdInfo(kLight light, kInfo *info)
Reports constraint and validity information for the ControlId setting.
kLightExt kLight_ExtensionAt(kLight light, kSize index)
Gets the control extension at the specified index.
kStatus kLight_AddState(kLight light, kLightState *state)
Creates and adds a new state with default values.
Represents a light state configuration.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:454
kStatus kLight_Enable(kLight light, kBool enable)
Enables or disables the light.
Represents light run-time statistics.
Definition: kNodeDef.h:827
Essential declarations related to FireSync nodes.
kStatus kLight_Override(kLight light, const kLightOverrideItem *overrides, kSize count)
Provides a list of configuration overrides to modify live light behaviour.
kLightState kLight_StateAt(kLight light, kSize index)
Gets the state at the specified index.
kStatus kLight_SetControl(kLight light, kLightControl type)
Sets the control mode of the light.
kStatus kLight_ClearAll(kLight light, kSize stateCount)
Resets light mode and device settings to defaults.
kStatus kLight_DeleteState(kLight light, kLightState state)
Destroys the specified state and removes it from the light's state list.
kBool kLight_IsEnabled(kLight light)
Reports whether the light is currently enabled.
kStatus kLight_Stats(kLight light, kLightStats *stats)
Retrieve statistics.
Represents light configuration.
Represents light control modes.
kSize kLight_StateCount(kLight light)
Gets the number of states belonging to the light.
kStatus kLight_ControlInfo(kLight light, kInfoBits *info)
Reports constraint and validity information for the Control setting.
k32u kLight_ControlId(kLight light)
Gets the control source id for a light.
kStatus kLight_PowerEnabledSaverInfo(kLight light, kInfoBool *info)
Reports constraint and validity information for the power saver.
kStatus kLight_EnablePowerSaver(kLight light, kBool enabled)
Enables power saver.
kStatus kLight_SetControlId(kLight light, k32u id)
Sets the control source id for a light.
kStatus kLight_LockedOutInfo(kLight light, kInfoBool *info)
Reports constraint and validity information for locking light output.
kLightControl kLight_Control(kLight light)
Reports the control mode of the light.
Represents constraint and validity information for a kSize setting.
Definition: kInfo.h:295
kStatus kLight_DeleteExtension(kLight light, kLightExt extension)
Destroys the specified light control extension and removes it from the light's extension list...
kStatus kLight_Clear(kLight light, kSize stateCount)
Resets light mode settings to defaults.
Abstract base class for light control extension parameters.
kSize kLight_ExtensionCount(kLight light)
Gets the number of control extensions that have been configured.
Represents constraint and validity information for a general setting.
Definition: kInfo.h:45
kStatus kLight_LockOut(kLight light, kBool shouldLock)
Enables locking of light output.
kBool kLight_IsLockedOut(kLight light)
Reports whether light output is locked or not.
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:403
kBool kLight_PowerSaverEnabled(kLight light)
Reports whether power saver is currently enabled.