#include <LedActivityAPI.h>
◆ LedActivityAPI()
oceandirect::api::LedActivityAPI::LedActivityAPI |
( |
| ) |
|
◆ ~LedActivityAPI()
virtual oceandirect::api::LedActivityAPI::~LedActivityAPI |
( |
| ) |
|
|
virtual |
◆ getInstance()
static LedActivityAPI * oceandirect::api::LedActivityAPI::getInstance |
( |
| ) |
|
|
static |
◆ getLedActivityEnable()
virtual bool oceandirect::api::LedActivityAPI::getLedActivityEnable |
( |
long | deviceID, |
|
|
int * | errorCode ) |
|
virtual |
Get the LED state.
- See also
- setLedActivityEnable()
- 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 LED is enabled, false otherwise.
◆ setLedActivityEnable()
virtual void oceandirect::api::LedActivityAPI::setLedActivityEnable |
( |
long | deviceID, |
|
|
int * | errorCode, |
|
|
bool | enable ) |
|
virtual |
Set the LED state.
- See also
- getLedActivityEnable()
- 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 enabble the LED, false to disable the LED. |
◆ shutdown()
static void oceandirect::api::LedActivityAPI::shutdown |
( |
| ) |
|
|
static |
◆ instance
The documentation for this class was generated from the following file: