OWLIFT C Library for Linux: Accessing Properties
OWLIFT C Library for Linux  1.9.3
Top Page
関数
Accessing Properties

関数

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)
 
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)
 

詳解

関数詳解

◆ OwLib_GetActive()

OwStatus_t OwLib_GetActive ( OwDev  dev,
BOOL *  activep 
)

デバイスが再生中かどうかを取得します。

引数
dev[in] デバイスハンドル。
activep[out] 再生状態が格納されます。 TRUE : 再生中, FALSE : それ以外。
戻り値
エラーコード。

◆ OwLib_GetCircumferenceCorrection()

BOOL OwLib_GetCircumferenceCorrection ( OwDev  dev)

円周方向の温度補正の有効・無効の状態を取得します。 OWLIFT Type-A のみで有効です。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetConfig()

OwStatus_t OwLib_GetConfig ( OwDev  dev,
UINT16 *  cfgp 
)

デバイスのコンフィグレーションを取得します。

引数
dev[in] デバイスハンドル。
cfgp[out] デバイスのコンフィグレーションが格納されます。値は以下に示すフラグ群です。
  • OWLIB_CONFIG_F_ALWAYS_ON
戻り値
エラーコード。

◆ OwLib_GetDisconnected()

BOOL OwLib_GetDisconnected ( OwDev  dev)

デバイスが切断されたかどうかを取得します。 制限事項として、OwLib_GetDeviceByCaptureFilter() によって取得したデバイスに対しては 常に FALSE が返されることに注意してください。

◆ OwLib_GetErrorMessage()

const char* OwLib_GetErrorMessage ( OwStatus_t  st)

エラーコードに対応するメッセージを取得します。

引数
st[in] ライブラリのエラーコード。
戻り値
エラーメッセージ。

◆ OwLib_GetFirmwareError()

OwFirmwareErrorCode_t OwLib_GetFirmwareError ( OwDev  dev)

最後に実行した関数で発生したデバイスのエラーコードを取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetFirmwareVersion()

UINT16 OwLib_GetFirmwareVersion ( OwDev  dev)

デバイスファームウェアのバージョンを取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。バージョン番号がX.Yのとき、b15..b8 がX、b7..b0 がYです。

◆ OwLib_GetFooterLines()

UINT16 OwLib_GetFooterLines ( OwDev  dev)

フレームデータの熱画像の末尾に付くライン数を取得します。 Telemetry Dataのライン数を含みます。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetFrameHeight()

UINT16 OwLib_GetFrameHeight ( OwDev  dev)

フレームの縦の解像度を取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetFrameRateDenominator()

int OwLib_GetFrameRateDenominator ( OwDev  dev)

フレームレートの分母を取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetFrameRateNumerator()

int OwLib_GetFrameRateNumerator ( OwDev  dev)

フレームレートの分子を取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetFrameWidth()

UINT16 OwLib_GetFrameWidth ( OwDev  dev)

フレームの横の解像度を取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetHostError()

OwHostErrorCode_t OwLib_GetHostError ( OwDev  dev)

最後に実行した関数で発生したホストのエラーコードを取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetLibVersion()

UINT32 OwLib_GetLibVersion ( void  )

ライブラリのバージョンを取得します。

戻り値
該当する値。バージョン番号がX.Y.Zのとき、b31..16 がX、b15..b8 がY、b7..b0 がZです。

◆ OwLib_GetNoiseFilter()

BOOL OwLib_GetNoiseFilter ( OwDev  dev)

ノイズフィルタの有効・無効の状態を取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetNoiseFilterThreshold()

UINT16 OwLib_GetNoiseFilterThreshold ( OwDev  dev)

ノイズフィルタの閾値を取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetProductID()

UINT16 OwLib_GetProductID ( OwDev  dev)

USBデバイスとしての Product ID (idProduct) を取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetReleaseNumber()

UINT16 OwLib_GetReleaseNumber ( OwDev  dev)

USBデバイスとしての Release Number (bcdDevice) を取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetSensorError()

OwSensorErrorCode_t OwLib_GetSensorError ( OwDev  dev)

最後に実行した関数で発生したセンサのエラーコードを取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetSerialNumber()

void OwLib_GetSerialNumber ( OwDev  dev,
UINT16 *  serialp 
)

センサモジュールのシリアル番号を取得します。

引数
dev[in] デバイスハンドル。
serialp[out] シリアル番号が格納されます。serialp の配列サイズは OWLIB_SERIAL_NUMBER_SIZE 以上である必要があります。

◆ OwLib_GetSerialNumberAsUINT64()

UINT64 OwLib_GetSerialNumberAsUINT64 ( OwDev  dev)

センサモジュールのシリアル番号を UINT64 型で取得します。

引数
dev[in] デバイスハンドル。
戻り値
シリアル番号。

◆ OwLib_GetSupportedFWVersion()

UINT16 OwLib_GetSupportedFWVersion ( void  )

サポートするデバイスファームウェアの最低バージョンを取得します。

戻り値
該当する値。バージョン番号がX.Yのとき、b15..b8 がX、b7..b0 がYです。

◆ OwLib_GetSupportedTelemetryDataRevision()

UINT16 OwLib_GetSupportedTelemetryDataRevision ( OwDev  dev)

接続中のデバイスが持つTelemetry Dataのリビジョンを取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetTelemetryDataLines()

UINT16 OwLib_GetTelemetryDataLines ( OwDev  dev)

フレームデータの熱画像の末尾に付くTelemetry Dataのライン数を取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetUndistortion()

BOOL OwLib_GetUndistortion ( OwDev  dev)

歪み補正の有効・無効の状態を取得します。 デフォルト値は OWLIFT Type-A/B のとき FALSE、OWLIFT Type-F のとき TRUE です。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_GetVendorID()

UINT16 OwLib_GetVendorID ( OwDev  dev)

USBデバイスとしての Vendor ID (idVendor) を取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_IsRealDevice()

BOOL OwLib_IsRealDevice ( OwDev  dev)

実デバイスと関連したデバイスハンドルかどうかを取得します。

引数
dev[in] デバイスハンドル。
戻り値
該当する値。

◆ OwLib_SetCircumferenceCorrection()

void OwLib_SetCircumferenceCorrection ( OwDev  dev,
BOOL  enabled 
)

円周方向の温度補正の有効・無効の状態を設定します。 OWLIFT Type-A のみで有効です。

引数
dev[in] デバイスハンドル。
enabled[in] TRUE : 有効, FALSE: 無効。

◆ OwLib_SetConfig()

OwStatus_t OwLib_SetConfig ( OwDev  dev,
UINT16  cfg 
)

デバイスのコンフィグレーションを設定します。

引数
dev[in] デバイスハンドル。
cfg[in] デバイスのコンフィグレーション。値については OwLib_GetConfig() を参照してください。
戻り値
エラーコード。

◆ OwLib_SetNoiseFilter()

void OwLib_SetNoiseFilter ( OwDev  dev,
BOOL  enabled 
)

ノイズフィルタの有効・無効の状態を設定します。

引数
dev[in] デバイスハンドル。
enabled[in] TRUE : 有効, FALSE: 無効。

◆ OwLib_SetNoiseFilterThreshold()

void OwLib_SetNoiseFilterThreshold ( OwDev  dev,
UINT16  threshold 
)

ノイズフィルタの閾値を設定します。

引数
dev[in] デバイスハンドル。
threshold[in] OWDECODE_NOISE_FILTER_THRESHOLD_MIN から OWDECODE_NOISE_FILTER_THRESHOLD_MAX の範囲の値。 OWDECODE_NOISE_FILTER_THRESHOLD_MIN のとき最も補正の強度が小さいです。

◆ OwLib_SetUndistortion()

void OwLib_SetUndistortion ( OwDev  dev,
BOOL  enabled 
)

歪み補正の有効・無効の状態を設定します。

引数
dev[in] デバイスハンドル。
enabled[in] TRUE : 有効, FALSE: 無効。