|
static ShutterAPI * | getInstance () |
|
static void | shutdown () |
|
◆ getShutterState()
virtual bool oceandirect::api::ShutterAPI::getShutterState |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
|
virtual |
Get the shutter on whether it's open or closed.
- See also
- setShutterOpen()
- 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
- Return true if the shutter is open otherwise it's false.
◆ setShutterOpen()
virtual void oceandirect::api::ShutterAPI::setShutterOpen |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
bool |
opened |
|
) |
| |
|
virtual |
Set the shutter to open or closed.
- See also
- getShutterState()
- 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. |
opened | true to open the shutter false to close the shutter. |
The documentation for this class was generated from the following file: