|
static LampAPI * | getInstance () |
|
static void | shutdown () |
|
◆ isStrobeLampEnable()
virtual bool oceandirect::api::LampAPI::isStrobeLampEnable |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
|
virtual |
Get the strobe lamp state.
- See also
- setStrobeLampEnable()
- 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 lamp is enabled, false otherwise.
◆ setStrobeLampEnable()
virtual void oceandirect::api::LampAPI::setStrobeLampEnable |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
bool |
enable |
|
) |
| |
|
virtual |
Set the strobe lamp state.
- See also
- isStrobeLampEnable()
- 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. |
enable | true to set strobe lamp enabled, false to disable. |
The documentation for this class was generated from the following file: