OWLIFT C Library for Windows: Accessing Properties
OWLIFT C Library for Windows  1.9.3
Top Page
Functions
Accessing Properties

Functions

UINT32 OwLib_GetLibVersion (void)
 
UINT16 OwLib_GetSupportedFWVersion (void)
 
UINT16 OwLib_GetVendorID (OwDev dev)
 
UINT16 OwLib_GetProductID (OwDev dev)
 
UINT16 OwLib_GetReleaseNumber (OwDev dev)
 
UINT16 OwLib_GetFirmwareVersion (OwDev dev)
 
void OwLib_GetSerialNumber (OwDev dev, UINT16 *serialp)
 
UINT64 OwLib_GetSerialNumberAsUINT64 (OwDev dev)
 
UINT16 OwLib_GetFrameWidth (OwDev dev)
 
UINT16 OwLib_GetFrameHeight (OwDev dev)
 
int OwLib_GetFrameRateDenominator (OwDev dev)
 
int OwLib_GetFrameRateNumerator (OwDev dev)
 
BOOL OwLib_GetCircumferenceCorrection (OwDev dev)
 
void OwLib_SetCircumferenceCorrection (OwDev dev, BOOL enabled)
 
BOOL OwLib_GetNoiseFilter (OwDev dev)
 
void OwLib_SetNoiseFilter (OwDev dev, BOOL enabled)
 
UINT16 OwLib_GetNoiseFilterThreshold (OwDev dev)
 
void OwLib_SetNoiseFilterThreshold (OwDev dev, UINT16 threshold)
 
BOOL OwLib_GetUndistortion (OwDev dev)
 
void OwLib_SetUndistortion (OwDev dev, BOOL enabled)
 
OwHostErrorCode_t OwLib_GetHostError (OwDev dev)
 
OwFirmwareErrorCode_t OwLib_GetFirmwareError (OwDev dev)
 
OwSensorErrorCode_t OwLib_GetSensorError (OwDev dev)
 
BOOL OwLib_GetDisconnected (OwDev dev)
 
const char * OwLib_GetErrorMessage (OwStatus_t st)
 
void * OwLib_GetCaptureFilter (OwDev dev)
 
OwStatus_t OwLib_GetConfig (OwDev dev, UINT16 *cfgp)
 
OwStatus_t OwLib_SetConfig (OwDev dev, UINT16 cfg)
 
OwStatus_t OwLib_GetActive (OwDev dev, BOOL *activep)
 
UINT16 OwLib_GetFooterLines (OwDev dev)
 
UINT16 OwLib_GetTelemetryDataLines (OwDev dev)
 
UINT16 OwLib_GetSupportedTelemetryDataRevision (OwDev dev)
 
BOOL OwLib_IsRealDevice (OwDev dev)
 

Detailed Description

Function Documentation

◆ OwLib_GetActive()

OwStatus_t OwLib_GetActive ( OwDev  dev,
BOOL *  activep 
)

Test if the device is capturing.

Parameters
dev[in] The device handle.
activep[out] The pointer that receives whether or not the device is capturing. TRUE : The device is capturing, FALSE : otherwise.
Returns
The error code.

◆ OwLib_GetCaptureFilter()

void* OwLib_GetCaptureFilter ( OwDev  dev)

Gets the DirectShow capture filter related to the device handle.

Parameters
dev[in] The device handle.
Returns
The object that represents a capture filter of which type is IBaseFilter*.

◆ OwLib_GetCircumferenceCorrection()

BOOL OwLib_GetCircumferenceCorrection ( OwDev  dev)

Returns whether or not the temperature correction of circumferential direction is enabled. This function only works with OWLIFT Type-A.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetConfig()

OwStatus_t OwLib_GetConfig ( OwDev  dev,
UINT16 *  cfgp 
)

Gets the device configuration.

Parameters
dev[in] The device handle.
cfgp[out] The pointer that receives the device configuration. The value is constructed with following flags.
  • OWLIB_CONFIG_F_ALWAYS_ON
Returns
The error code.

◆ OwLib_GetDisconnected()

BOOL OwLib_GetDisconnected ( OwDev  dev)

Gets whether or not the device was disconnected. As a restriction, this function always returns FALSE if the device was gotten by OwLib_GetDeviceByCaptureFilter().

◆ OwLib_GetErrorMessage()

const char* OwLib_GetErrorMessage ( OwStatus_t  st)

Gets the corresponding messsage to the error code.

Parameters
st[in] The library error code.
Returns
The error message.

◆ OwLib_GetFirmwareError()

OwFirmwareErrorCode_t OwLib_GetFirmwareError ( OwDev  dev)

Gets the device error code occurred in the function that was called last.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetFirmwareVersion()

UINT16 OwLib_GetFirmwareVersion ( OwDev  dev)

Gets the device firmware version number.

Parameters
dev[in] The device handle.
Returns
The corresponding value. If the version number is X.Y X is assigned to b15..8, Y is assigned to b7..b0.

◆ OwLib_GetFooterLines()

UINT16 OwLib_GetFooterLines ( OwDev  dev)

Returns the number of trailing lines after a thermography block in a frame data. This includes the number of lines of Telemetry Data.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetFrameHeight()

UINT16 OwLib_GetFrameHeight ( OwDev  dev)

Returns the vertical resolution of the frame.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetFrameRateDenominator()

int OwLib_GetFrameRateDenominator ( OwDev  dev)

Returns the denominator of the frame rate.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetFrameRateNumerator()

int OwLib_GetFrameRateNumerator ( OwDev  dev)

Returns the numerator of the frame rate.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetFrameWidth()

UINT16 OwLib_GetFrameWidth ( OwDev  dev)

Returns the horizontal resolution of the frame.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetHostError()

OwHostErrorCode_t OwLib_GetHostError ( OwDev  dev)

Gets the host error code occurred in the function that was called last.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetLibVersion()

UINT32 OwLib_GetLibVersion ( void  )

Gets the library version number.

Returns
The corresponding value. If the version number is X.Y.Z, X is assigned to b31..16, Y is assigned to b15..b8 and Z is assigned b7..b0.

◆ OwLib_GetNoiseFilter()

BOOL OwLib_GetNoiseFilter ( OwDev  dev)

Returns whether or not the Noise Filter is enabled.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetNoiseFilterThreshold()

UINT16 OwLib_GetNoiseFilterThreshold ( OwDev  dev)

Gets the threshold of the Noise Filter.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetProductID()

UINT16 OwLib_GetProductID ( OwDev  dev)

Gets the Product ID (idProduct) as an USB device.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetReleaseNumber()

UINT16 OwLib_GetReleaseNumber ( OwDev  dev)

Gets the Release Number (bcdDevice) as an USB device.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetSensorError()

OwSensorErrorCode_t OwLib_GetSensorError ( OwDev  dev)

Gets the sensor error code occurred in the function that was called last.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetSerialNumber()

void OwLib_GetSerialNumber ( OwDev  dev,
UINT16 *  serialp 
)

Gets the serial number of the sensor module.

Parameters
dev[in] The device handle.
serialp[out] The pointer that receives the serial number. The array size of serialp must be greater than or equal to OWLIB_SERIAL_NUMBER_SIZE.

◆ OwLib_GetSerialNumberAsUINT64()

UINT64 OwLib_GetSerialNumberAsUINT64 ( OwDev  dev)

Gets the serial number of the sensor module as UINT64 type.

Parameters
dev[in] The device handle.
Returns
The serial number.

◆ OwLib_GetSupportedFWVersion()

UINT16 OwLib_GetSupportedFWVersion ( void  )

Gets the minimum supported version number of the device firmware.

Returns
The corresponding value. If the version number is X.Y X is assigned to b15..8, Y is assigned to b7..b0.

◆ OwLib_GetSupportedTelemetryDataRevision()

UINT16 OwLib_GetSupportedTelemetryDataRevision ( OwDev  dev)

Returns a revision number of the telemetry data that the connected device has.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetTelemetryDataLines()

UINT16 OwLib_GetTelemetryDataLines ( OwDev  dev)

Returns the number of trailing lines which represent Telemetry Data after a thermography block in a frame data.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetUndistortion()

BOOL OwLib_GetUndistortion ( OwDev  dev)

Returns whether or not the Undistortion is enabled. The default value is FALSE for OWLIFT Type-A/B, is TRUE for OWLIFT Type-F.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_GetVendorID()

UINT16 OwLib_GetVendorID ( OwDev  dev)

Gets the Vendor ID (idVendor) as an USB device.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_IsRealDevice()

BOOL OwLib_IsRealDevice ( OwDev  dev)

Returns whether or not the specified handle is related to a real device.

Parameters
dev[in] The device handle.
Returns
The corresponding value.

◆ OwLib_SetCircumferenceCorrection()

void OwLib_SetCircumferenceCorrection ( OwDev  dev,
BOOL  enabled 
)

Enables or disables the temperature correction of circumferential direction. This function only works with OWLIFT Type-A.

Parameters
dev[in] The device handle.
enabled[in] TRUE : enabled, FALSE: disabled.

◆ OwLib_SetConfig()

OwStatus_t OwLib_SetConfig ( OwDev  dev,
UINT16  cfg 
)

Sets the device configuration.

Parameters
dev[in] The device handle.
cfg[in] The device configuration value. See OwLib_GetCaptureFilter() about the value.
Returns
The error code.

◆ OwLib_SetNoiseFilter()

void OwLib_SetNoiseFilter ( OwDev  dev,
BOOL  enabled 
)

Enables or disables the Noise Filter.

Parameters
dev[in] The device handle.
enabled[in] TRUE : enabled, FALSE: disabled.

◆ OwLib_SetNoiseFilterThreshold()

void OwLib_SetNoiseFilterThreshold ( OwDev  dev,
UINT16  threshold 
)

Sets the threshold of the Noise Filter.

Parameters
dev[in] The device handle.
threshold[in] The value from OWDECODE_NOISE_FILTER_THRESHOLD_MIN to OWDECODE_NOISE_FILTER_THRESHOLD_MAX. OWDECODE_NOISE_FILTER_THRESHOLD_MIN is minimum correction strength.

◆ OwLib_SetUndistortion()

void OwLib_SetUndistortion ( OwDev  dev,
BOOL  enabled 
)

Enables or disables the Undistortion.

Parameters
dev[in] The device handle.
enabled[in] TRUE : enabled, FALSE: disabled.