|
int | getCount (long deviceID, int *errorCode) |
|
double | getIntensity (long deviceID, int *errorCode, int lightSourceIndex) |
|
bool | getLampStrobeEnable (long deviceID, int *errorCode) |
|
bool | hasEnable (long deviceID, int *errorCode, int lightSourceIndex) |
|
bool | hasVariableIntensity (long deviceID, int *errorCode, int lightSourceIndex) |
|
bool | isEnabled (long deviceID, int *errorCode, int lightSourceIndex) |
|
void | setEnable (long deviceID, int *errorCode, int lightSourceIndex, bool enable) |
|
void | setIntensity (long deviceID, int *errorCode, int lightSourceIndex, double intensity) |
|
void | setLampStrobeEnable (long deviceID, int *errorCode, bool strobeEnable) |
|
◆ getCount()
int oceandirect::api::LightSourceAPI::getCount |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Get the number of light sources.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
- Returns
- the number light sources.
◆ getIntensity()
double oceandirect::api::LightSourceAPI::getIntensity |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
lightSourceIndex |
|
) |
| |
Determine the intensity of the specified light source.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
lightSourceIndex | the index of the specified light source. |
- Returns
- the intensity of the specified light source.
◆ getLampStrobeEnable()
bool oceandirect::api::LightSourceAPI::getLampStrobeEnable |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Get strobe enable.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
- Returns
- true if strobe is enabled, false otherwise.
◆ hasEnable()
bool oceandirect::api::LightSourceAPI::hasEnable |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
lightSourceIndex |
|
) |
| |
Determine if the specified light source has enable/disable functionality.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
lightSourceIndex | the index of the specified light source. |
- Returns
- true if the light source has enable/disable capability, false otherwise.
◆ hasVariableIntensity()
bool oceandirect::api::LightSourceAPI::hasVariableIntensity |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
lightSourceIndex |
|
) |
| |
Determine if the specified light source has a variable intensity setting.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
lightSourceIndex | the index of the specified light source. |
- Returns
- true if the light source has variable intensity, false otherwise.
◆ isEnabled()
bool oceandirect::api::LightSourceAPI::isEnabled |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
lightSourceIndex |
|
) |
| |
Determine if the specified light source is enabled or disabled.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
lightSourceIndex | the index of the specified light source. |
- Returns
- true if the light source is enabled, false if the light source is disabled.
◆ setEnable()
void oceandirect::api::LightSourceAPI::setEnable |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
lightSourceIndex, |
|
|
bool |
enable |
|
) |
| |
Set the specified light source to enabled or disabled.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
lightSourceIndex | the index of the specified light source. |
enable | true to enable the light source, false to disable the light source. |
◆ setIntensity()
void oceandirect::api::LightSourceAPI::setIntensity |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
lightSourceIndex, |
|
|
double |
intensity |
|
) |
| |
Set the intensity of the specified light source.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
lightSourceIndex | the index of the specified light source. |
intensity | the desired intensity of the specified light source. |
◆ setLampStrobeEnable()
void oceandirect::api::LightSourceAPI::setLampStrobeEnable |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
bool |
strobeEnable |
|
) |
| |
Set strobe enable.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
strobeEnable | true to set strobe enable, false to disable. |
The documentation for this class was generated from the following file: