2668 lines
102 KiB
C
Raw Normal View History

2026-03-28 10:49:55 +08:00
// clang-format off
/**
\~chinese
* @file IKapCDeprecated.h
* @brief IKapC库头文件()
*/
/**
\~english
* @file IKapCDeprecated.h
* @brief IKapC library header(Deprecated API)
*/
#ifndef _IKAPCDEPRECATED_H
#define _IKAPCDEPRECATED_H
#include "IKapCDef.h"
#ifdef __cplusplus
// avoid namespace ambiguities between std::_Bool (from yvals.h) and ::_Bool (from IKapCTypes.h)
# if defined(_MSC_VER)
# define _Bool ::_Bool ///< @brief \~chinese 布尔类型 \~english Boolean type
# define IKAPC_BOOL_DEFINED
# endif
/*Deprecated*/
/**
\~chinese
* @brief RO
* @note
* 1. ITKBUFFER_PRM_FORMAT
* 2. pValue/value为 uint32_t
* @deprecated 使 ITKBUFFER_PRM_PIXEL_BITS
*/
/**
\~english
* @brief Buffer image depth [RO]
* @note
* 1. This parameter cannot be set, the value is determined by buffer pixel format ITKBUFFER_PRM_FORMAT .
* 2. The corresponding pValue/value of this parameter is uint32_t type data.
* @deprecated May be removed in future versions, please use ITKBUFFER_PRM_IMAGE_BITS instead.
*/
#define ITKBUFFER_PRM_DATA_BIT ITKBUFFER_PRM(1, 4)
/**
\~chinese
* @brief RO
* @note
* 1. ITKBUFFER_PRM_FORMAT
* 2. pValue/value为 uint32_t
* @deprecated 使 ITKBUFFER_PRM_CHANNEL_BITS
*/
/**
\~english
* @brief Buffer channel depth [RO]
* @note
* 1. This parameter cannot be set, the value is determined by buffer pixel format ITKBUFFER_PRM_FORMAT .
* 2. The corresponding pValue/value of this parameter is uint32_t type data.
* @deprecated May be removed in future versions, please use ITKBUFFER_PRM_CHANNEL_BITS instead.
*/
#define ITKBUFFER_PRM_PIXEL_DEPTH ITKBUFFER_PRM(2, 4)
#define ITKBUFFER_FORMATL_DATA_BIT(format) (((format) >> 8) & 0xFF)
/**
\~chinese
* @brief
* @deprecated 使 ITKBUFFER_FORMAT_PIXEL_BITS
*/
/**
\~english
* @brief Single pixel size
* @deprecated May be removed in future versions, please use ITKBUFFER_FORMAT_PIXEL_BITS instead.
*/
#define ITKBUFFER_FORMAT_DATA_BIT(format) (((format) >> 8) & 0xFF)
/**
\~chinese
* @brief
* @deprecated 使 ITKBUFFER_FORMAT_CHANNEL_BITS
*/
/**
\~english
* @brief Single channel size
* @deprecated May be removed in future versions, please use ITKBUFFER_FORMAT_CHANNEL_BITS instead.
*/
#define ITKBUFFER_FORMAT_PIXEL_DEPTH(format) (((format) >> 16) & 0xFF)
/**
\~chinese
* @brief RO
* @note
* 1. pValue/value为 ITKBUFFER
* @deprecated 使 ItkStreamGetCurrentBuffer
*/
/**
\~english
* @brief Handle of current buffer [RO]
* @note This parameter indicates handle of current buffer.
* 1. The corresponding pValue/value of this parameter is ITKBUFFER type data.
* @deprecated This parameter is obsolete, please use ItkStreamGetCurrentBuffer instead.
*/
#define ITKSTREAM_PRM_CURRENT_BUFFER_HANDLE ITKSTREAM_PRM(16, 8)
extern "C" {
#endif // __cplusplus
/**
\~chinese
* @brief PC上采集卡设备的数量
* @param[out] pCount PC上的采集卡的数量
* @return
* - ITKSTATUS_OK
*/
/**
\~english
* @brief Get the current number of frame grabber devices connected to PC
* @param[out] pCount The current number of frame grabber connected to PC
* @return
* - ITKSTATUS_OK
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkManGetBoardCount(uint32_t* pCount);
/**
\~chinese
* @brief
* @param[in] index
* @param[out] pBI
* @return
* - ITKSTATUS_OK
* @note ItkManGetBoardCount
*/
/**
\~english
* @brief Get frame grabber device information
* @param[in] index Frame grabber index
* @param[out] pBI Frame grabber information
* @return
* - ITKSTATUS_OK
* @note Before calling this function, ItkManGetBoardCount must be called first.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkManGetBoardInfo(uint32_t index, PITKBOARD_INFO pBI);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] name
* @param[out] phFeature
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_HANDLE
* @note ITKFEATURE
*/
/**
\~english
* @brief Request for resources required to configure camera feature
* @param[in] hDev Camera device handle
* @param[in] name Feature name
* @param[out] phFeature Camera feature handle
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_HANDLE
* @note All information about the features is stored in ITKFEATURE handle, including feature name, feature type, parameter range, etc.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevAllocFeature(ITKDEVICE hDev, const char* name, ITKFEATURE* phFeature);
/**
\~chinese
* @brief
* @param[in] hFeature
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_HANDLE
* @note
*/
/**
\~english
* @brief Release configuration camera feature resources
* @param[in] hFeature Camera feature handle
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_HANDLE
* @note After releasing the handle, camera parameters cannot be configured again through the handle.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevFreeFeature(ITKFEATURE hFeature);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] index [0, ItkDevGetStreamCount -1]
* @param[in] hBuffer
* @param[out] phStream
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* 1.
* 2.
* @deprecated 使 ItkDevAllocStreamEx
*/
/**
\~english
* @brief Request for resources during the process of applying for data stream acquisition
* @param[in] hDev Camera device handle
* @param[in] index Data stream index, valid range is [0, ItkDevGetStreamCount -1]
* @param[in] hBuffer Buffer handle, default data stream destination
* @param[out] phStream Data stream handle, controlling the entire life cycle of data stream
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* 1. For the same camera, there may be multiple data streams grab data simultaneously. Use an index to indicate the desired data stream to grab.
* 2. During the process of grabbing data stream resources, a data buffer must be specified to store the image data grabbed during acquisition process.
* @deprecated This interface is obsolete, please use ItkDevAllocStreamEx instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevAllocStream(ITKDEVICE hDev, uint32_t index, ITKBUFFER hBuffer, ITKSTREAM* phStream);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[out] pBuffer
* @param[out] length
* @param[in] timeout
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
*/
/**
\~english
* @brief Read data from serial port
* @param[in] hDev Camera device handle
* @param[out] pBuffer Buffer for storing data
* @param[out] length Register address
* @param[in] timeout Read timeout time
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note The data read from serial port will be written to the buffer, please ensure that the buffer size is sufficient.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevSerialPortRead(ITKDEVICE hDev, void* pBuffer, uint32_t* length, uint32_t timeout);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] pBuffer
* @param[in] length
* @param[in] timeout
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* @see ItkDevSerialPortRead
*/
/**
\~english
* @brief Write data to serial port
* @param[in] hDev Camera device handle
* @param[in] pBuffer Buffer for storing data
* @param[in] length Register address
* @param[in] timeout Read timeout time
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note The data read from the buffer will be written to serial port, please ensure that the buffer size is sufficient.
* @see ItkDevSerialPortRead
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevSerialPortWrite(ITKDEVICE hDev, const void* pBuffer, uint32_t length, uint32_t timeout);
/**
\~chinese
* @brief 访
* @param[in] hFeature
* @param[out] pAccessMode 访
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note 访
* | 访 |
* |--------------------------------------|
* | ITKFEATURE_VAL_ACCESS_MODE_UNDEFINED |
* | ITKFEATURE_VAL_ACCESS_MODE_RW |
* | ITKFEATURE_VAL_ACCESS_MODE_RO |
* | ITKFEATURE_VAL_ACCESS_MODE_WO |
* | ITKFEATURE_VAL_ACCESS_MODE_NI |
* | ITKFEATURE_VAL_ACCESS_MODE_NA |
* @deprecated 使 ItkDevGetAccessMode
*/
/**
\~english
* @brief Get camera feature access mode
* @param[in] hFeature Camera feature handle
* @param[out] pAccessMode Camera feature access mode
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note The available options for feature access mode are as follows:
* | Access mode |
* |--------------------------------------|
* | ITKFEATURE_VAL_ACCESS_MODE_UNDEFINED |
* | ITKFEATURE_VAL_ACCESS_MODE_RW |
* | ITKFEATURE_VAL_ACCESS_MODE_RO |
* | ITKFEATURE_VAL_ACCESS_MODE_WO |
* | ITKFEATURE_VAL_ACCESS_MODE_NI |
* | ITKFEATURE_VAL_ACCESS_MODE_NA |
* @deprecated This interface is obsolete, please use ItkDevGetAccessMode instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetAccessMode(ITKFEATURE hFeature, uint32_t* pAccessMode);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pCategory
* @param[in,out] pBufferSize
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get camera feature category
* @param[in] hFeature Camera feature handle
* @param[out] pCategory Category of camera feature
* @param[in,out] pBufferSize As input, it indicates the maximum length of feature category. As output, it indicates the effective length of feature category
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetCategory(ITKFEATURE hFeature, char* pCategory, uint32_t* pBufferSize);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[out] pCategory
* @param[in,out] pBufferSize
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get camera feature category
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pCategory Category of camera feature
* @param[in,out] pBufferSize As input, it indicates the maximum length of feature category. As output, it indicates the effective length of feature category
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC
ItkDevGetCategory(ITKDEVICE hDev, const char* featureName, char* pCategory, uint32_t* pBufferSize);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pType
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* | |
* |-------------------------------|
* | ITKFEATURE_VAL_TYPE_UNDEFINED |
* | ITKFEATURE_VAL_TYPE_INT32 |
* | ITKFEATURE_VAL_TYPE_INT64 |
* | ITKFEATURE_VAL_TYPE_FLOAT |
* | ITKFEATURE_VAL_TYPE_DOUBLE |
* | ITKFEATURE_VAL_TYPE_BOOL |
* | ITKFEATURE_VAL_TYPE_ENUM |
* | ITKFEATURE_VAL_TYPE_STRING |
* | ITKFEATURE_VAL_TYPE_COMMAND |
* | ITKFEATURE_VAL_TYPE_CATEGORY |
* | ITKFEATURE_VAL_TYPE_REGISTER |
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get camera feature data type
* @param[in] hFeature Camera feature handle
* @param[out] pType Camera feature data type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note The available options for feature data types are as follows:
* | Data type |
* |-------------------------------|
* | ITKFEATURE_VAL_TYPE_UNDEFINED |
* | ITKFEATURE_VAL_TYPE_INT32 |
* | ITKFEATURE_VAL_TYPE_INT64 |
* | ITKFEATURE_VAL_TYPE_FLOAT |
* | ITKFEATURE_VAL_TYPE_DOUBLE |
* | ITKFEATURE_VAL_TYPE_BOOL |
* | ITKFEATURE_VAL_TYPE_ENUM |
* | ITKFEATURE_VAL_TYPE_STRING |
* | ITKFEATURE_VAL_TYPE_COMMAND |
* | ITKFEATURE_VAL_TYPE_CATEGORY |
* | ITKFEATURE_VAL_TYPE_REGISTER |
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetType(ITKFEATURE hFeature, uint32_t* pType);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[out] pType
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* | |
* |-------------------------------|
* | ITKFEATURE_VAL_TYPE_UNDEFINED |
* | ITKFEATURE_VAL_TYPE_INT32 |
* | ITKFEATURE_VAL_TYPE_INT64 |
* | ITKFEATURE_VAL_TYPE_FLOAT |
* | ITKFEATURE_VAL_TYPE_DOUBLE |
* | ITKFEATURE_VAL_TYPE_BOOL |
* | ITKFEATURE_VAL_TYPE_ENUM |
* | ITKFEATURE_VAL_TYPE_STRING |
* | ITKFEATURE_VAL_TYPE_COMMAND |
* | ITKFEATURE_VAL_TYPE_CATEGORY |
* | ITKFEATURE_VAL_TYPE_REGISTER |
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get camera feature data type
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pType Camera feature data type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note The available options for feature data types are as follows:
* | Data type |
* |-------------------------------|
* | ITKFEATURE_VAL_TYPE_UNDEFINED |
* | ITKFEATURE_VAL_TYPE_INT32 |
* | ITKFEATURE_VAL_TYPE_INT64 |
* | ITKFEATURE_VAL_TYPE_FLOAT |
* | ITKFEATURE_VAL_TYPE_DOUBLE |
* | ITKFEATURE_VAL_TYPE_BOOL |
* | ITKFEATURE_VAL_TYPE_ENUM |
* | ITKFEATURE_VAL_TYPE_STRING |
* | ITKFEATURE_VAL_TYPE_COMMAND |
* | ITKFEATURE_VAL_TYPE_CATEGORY |
* | ITKFEATURE_VAL_TYPE_REGISTER |
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetType(ITKDEVICE hDev, const char* featureName, uint32_t* pType);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] featureName
* @param[in,out] nameSize
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note GUI界面中显示特征
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get camera feature display name
* @param[in] hFeature Camera feature handle
* @param[out] featureName Camera feature display name
* @param[in,out] nameSize As input, it indicates the maximum length of display name. As output, it indicates the effective length of the display name
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note The camera feature display name and name are different.
The former is used to display feature in GUI interface, while the latter uniquely identifies camera feature.
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetDisplayName(ITKFEATURE hFeature, char* featureName, uint32_t* pNameSize);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[out] featureDisplayName
* @param[in,out] nameSize
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note GUI界面中显示特征
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get camera feature display name
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] featureDisplayName Camera feature display name
* @param[in,out] nameSize As input, it indicates the maximum length of display name. As output, it indicates the effective length of the display name
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note The camera feature display name and name are different.
The former is used to display feature in GUI interface, while the latter uniquely identifies camera feature.
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC
ItkDevGetDisplayName(ITKDEVICE hDev, const char* featureName, char* featureDisplayName, uint32_t* pNameSize);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pBuff
* @param[in,out] pBufLen
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
pBuff设置为NULLpBufLen指向的变量将设置为所需的缓冲区大小
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get camera feature tooltip information
* @param[in] hFeature Camera feature handle
* @param[out] pBuff Camera feature tooltip information
* @param[in,out] pBufLen As input, it indicates the maximum length of tooltip information. As output, it indicates the effective length of tooltip information
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note The feature tooltip information is a text string that briefly describes the node and its purpose,
and the buffer passed to this function must be sufficient to accommodate the entire string.
If pBuff is set to NULL when calling this function, the variable pointed to by pBufLen will be set to the desired buffer size.
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetTooltip(ITKFEATURE hFeature, char* pBuff, uint32_t* pBufLen);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[out] pBuff
* @param[in,out] pBufLen
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
pBuff设置为NULLpBufLen指向的变量将设置为所需的缓冲区大小
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get camera feature tooltip information
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pBuff Camera feature tooltip information
* @param[in,out] pBufLen As input, it indicates the maximum length of tooltip information. As output, it indicates the effective length of tooltip information
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note The feature tooltip information is a text string that briefly describes the node and its purpose,
and the buffer passed to this function must be sufficient to accommodate the entire string.
If pBuff is set to NULL when calling this function, the variable pointed to by pBufLen will be set to the desired buffer size.
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetTooltip(ITKDEVICE hDev, const char* featureName, char* pBuff, uint32_t* pBufLen);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pBuff
* @param[in,out] pBufLen
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note ItkDevGetTooltip
pBuff将设置为NULLpBufLen指向的变量将设置为所需的缓冲区大小
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get specific description information of camera feature
* @param[in] hFeature Camera feature handle
* @param[out] pBuff Detailed description of camera feature
* @param[in,out] pBufLen As input, it indicates the maximum length of detailed description information. As output, it indicates the effective length of detailed description information
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note The specific feature description information is a text string that describes the node and its purpose,
which is more detailed than the information obtained by ItkDevGetTooltip. The buffer passed to this function must be sufficient to accommodate the entire string.
If pBuff is set to NULL when calling this function, the variable pointed to by pBufLen will be set to the desired buffer size.
* deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetDescription(ITKFEATURE hFeature, char* pBuff, uint32_t* pBufLen);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[out] pBuff
* @param[in,out] pBufLen
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note ItkDevGetTooltip
pBuff将设置为NULLpBufLen指向的变量将设置为所需的缓冲区大小
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get specific description information of camera feature
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pBuff Detailed description of camera feature
* @param[in,out] pBufLen As input, it indicates the maximum length of detailed description information. As output, it indicates the effective length of detailed description information
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note The specific feature description information is a text string that describes the node and its purpose,
which is more detailed than the information obtained by ItkDevGetTooltip. The buffer passed to this function must be sufficient to accommodate the entire string.
If pBuff is set to NULL when calling this function, the variable pointed to by pBufLen will be set to the desired buffer size.
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetDescription(ITKDEVICE hDev, const char* featureName, char* pBuff, uint32_t* pBufLen);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pNameSpace
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* | |
* |-------------------------------------|
* | ITKFEATURE_VAL_NAME_SPACE_UNDEFINED |
* | ITKFEATURE_VAL_NAME_SPACE_CUSTOM |
* | ITKFEATURE_VAL_NAME_SPACE_STANDARD |
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get camera feature name space
* @param[in] hFeature Camera feature handle
* @param[out] pNameSpace Camera feature name space
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note The feature name space options are as follows:
* | Name space |
* |-------------------------------------|
* | ITKFEATURE_VAL_NAME_SPACE_UNDEFINED |
* | ITKFEATURE_VAL_NAME_SPACE_CUSTOM |
* | ITKFEATURE_VAL_NAME_SPACE_STANDARD |
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetNameSpace(ITKFEATURE hFeature, uint32_t* pNameSpace);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[out] pNameSpace
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* | |
* |-------------------------------------|
* | ITKFEATURE_VAL_NAME_SPACE_UNDEFINED |
* | ITKFEATURE_VAL_NAME_SPACE_CUSTOM |
* | ITKFEATURE_VAL_NAME_SPACE_STANDARD |
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get camera feature name space
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pNameSpace Camera feature name space
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note The feature name space options are as follows:
* | Name space |
* |-------------------------------------|
* | ITKFEATURE_VAL_NAME_SPACE_UNDEFINED |
* | ITKFEATURE_VAL_NAME_SPACE_CUSTOM |
* | ITKFEATURE_VAL_NAME_SPACE_STANDARD |
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetNameSpace(ITKDEVICE hDev, const char* featureName, uint32_t* pNameSpace);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pVis
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* | |
* |-------------------------------------|
* | ITKFEATURE_VAL_VISIBILITY_UNDEFINED |
* | ITKFEATURE_VAL_VISIBILITY_BEGINNER |
* | ITKFEATURE_VAL_VISIBILITY_EXPERT |
* | ITKFEATURE_VAL_VISIBILITY_GURU |
* | ITKFEATURE_VAL_VISIBILITY_INVISIBLE |
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get camera feature visibility
* @param[in] hFeature Camera feature handle
* @param[out] pVis Camera feature visibility
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note The options for feature visibility are as follows:
* | Visibility |
* |-------------------------------------|
* | ITKFEATURE_VAL_VISIBILITY_UNDEFINED |
* | ITKFEATURE_VAL_VISIBILITY_BEGINNER |
* | ITKFEATURE_VAL_VISIBILITY_EXPERT |
* | ITKFEATURE_VAL_VISIBILITY_GURU |
* | ITKFEATURE_VAL_VISIBILITY_INVISIBLE |
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetVisibility(ITKFEATURE hFeature, uint32_t* pVis);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[out] pVis
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* | |
* |-------------------------------------|
* | ITKFEATURE_VAL_VISIBILITY_UNDEFINED |
* | ITKFEATURE_VAL_VISIBILITY_BEGINNER |
* | ITKFEATURE_VAL_VISIBILITY_EXPERT |
* | ITKFEATURE_VAL_VISIBILITY_GURU |
* | ITKFEATURE_VAL_VISIBILITY_INVISIBLE |
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get camera feature visibility
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pVis Camera feature visibility
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note The options for feature visibility are as follows:
* | Visibility |
* |-------------------------------------|
* | ITKFEATURE_VAL_VISIBILITY_UNDEFINED |
* | ITKFEATURE_VAL_VISIBILITY_BEGINNER |
* | ITKFEATURE_VAL_VISIBILITY_EXPERT |
* | ITKFEATURE_VAL_VISIBILITY_GURU |
* | ITKFEATURE_VAL_VISIBILITY_INVISIBLE |
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetVisibility(ITKDEVICE hDev, const char* featureName, uint32_t* pVis);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pRep
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* 1. ITKFEATURE_VAL_REPRESENTATION_UNDEFINED
* 2.
* | |
* |-------------------------------------------|
* | ITKFEATURE_VAL_REPRESENTATION_UNDEFINED |
* | ITKFEATURE_VAL_REPRESENTATION_LINEAR |
* | ITKFEATURE_VAL_REPRESENTATION_LOGARITHMIC |
* | ITKFEATURE_VAL_REPRESENTATION_BOOLEAN |
* | ITKFEATURE_VAL_REPRESENTATION_PURENUMBER |
* | ITKFEATURE_VAL_REPRESENTATION_HEXNUMBER |
* | ITKFEATURE_VAL_REPRESENTATION_IPV4ADDRESS |
* | ITKFEATURE_VAL_REPRESENTATION_MACADDRESS |
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get camera feature representation method
* @param[in] hFeature Camera feature handle
* @param[out] pRep Camera feature representation method
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* 1. This function is only valid for integer type features, and for other type features, the representation takes the value ITKFEATURE_VAL_REPRESENTATION_UNDEFINED .
* 2. The options for feature representation are as follows:
* | Representation method |
* |-------------------------------------------|
* | ITKFEATURE_VAL_REPRESENTATION_UNDEFINED |
* | ITKFEATURE_VAL_REPRESENTATION_LINEAR |
* | ITKFEATURE_VAL_REPRESENTATION_LOGARITHMIC |
* | ITKFEATURE_VAL_REPRESENTATION_BOOLEAN |
* | ITKFEATURE_VAL_REPRESENTATION_PURENUMBER |
* | ITKFEATURE_VAL_REPRESENTATION_HEXNUMBER |
* | ITKFEATURE_VAL_REPRESENTATION_IPV4ADDRESS |
* | ITKFEATURE_VAL_REPRESENTATION_MACADDRESS |
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetRepresentation(ITKFEATURE hFeature, uint32_t* pRep);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[out] pRep
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* 1. ITKFEATURE_VAL_REPRESENTATION_UNDEFINED
* 2.
* | |
* |-------------------------------------------|
* | ITKFEATURE_VAL_REPRESENTATION_UNDEFINED |
* | ITKFEATURE_VAL_REPRESENTATION_LINEAR |
* | ITKFEATURE_VAL_REPRESENTATION_LOGARITHMIC |
* | ITKFEATURE_VAL_REPRESENTATION_BOOLEAN |
* | ITKFEATURE_VAL_REPRESENTATION_PURENUMBER |
* | ITKFEATURE_VAL_REPRESENTATION_HEXNUMBER |
* | ITKFEATURE_VAL_REPRESENTATION_IPV4ADDRESS |
* | ITKFEATURE_VAL_REPRESENTATION_MACADDRESS |
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Get camera feature representation method
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pRep Camera feature representation method
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* 1. This function is only valid for integer type features, and for other type features, the representation takes the value ITKFEATURE_VAL_REPRESENTATION_UNDEFINED .
* 2. The options for feature representation are as follows:
* | Representation method |
* |-------------------------------------------|
* | ITKFEATURE_VAL_REPRESENTATION_UNDEFINED |
* | ITKFEATURE_VAL_REPRESENTATION_LINEAR |
* | ITKFEATURE_VAL_REPRESENTATION_LOGARITHMIC |
* | ITKFEATURE_VAL_REPRESENTATION_BOOLEAN |
* | ITKFEATURE_VAL_REPRESENTATION_PURENUMBER |
* | ITKFEATURE_VAL_REPRESENTATION_HEXNUMBER |
* | ITKFEATURE_VAL_REPRESENTATION_IPV4ADDRESS |
* | ITKFEATURE_VAL_REPRESENTATION_MACADDRESS |
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetRepresentation(ITKDEVICE hDev, const char* featureName, uint32_t* pRep);
/**
\~chinese
* @brief 32
* @param[in] hFeature
* @param[out] pValue 32
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
/**
\~english
* @brief Get the minimum value of 32bit integer type feature
* @param[in] hFeature Camera feature handle
* @param[out] pValue Minimum value of 32bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetInt32Min(ITKFEATURE hFeature, int32_t* pValue);
/**
\~chinese
* @brief 32
* @param[in] hDev
* @param[in] featureName
* @param[out] pValue 32
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
/**
\~english
* @brief Get the minimum value of 32bit integer type feature
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pValue Minimum value of 32bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetInt32Min(ITKDEVICE hDev, const char* featureName, int32_t* pValue);
/**
\~chinese
* @brief 32
* @param[in] hFeature
* @param[out] pValue 32
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
/**
\~english
* @brief Get the maximum value of 32bit integer type feature
* @param[in] hFeature Camera feature handle
* @param[out] pValue Maximum value of 32bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetInt32Max(ITKFEATURE hFeature, int32_t* pValue);
/**
\~chinese
* @brief 32
* @param[in] hDev
* @param[in] featureName
* @param[out] pValue 32
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
/**
\~english
* @brief Get the maximum value of 32bit integer type feature
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pValue Maximum value of 32bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetInt32Max(ITKDEVICE hDev, const char* featureName, int32_t* pValue);
/**
\~chinese
* @brief 32
* @param[in] hFeature
* @param[out] pValue 32
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
/**
\~english
* @brief Get the increment of 32bit integer type feature
* @param[in] hFeature Camera feature handle
* @param[out] pValue Increment of 32bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetInt32Inc(ITKFEATURE hFeature, int32_t* pValue);
/**
\~chinese
* @brief 32
* @param[in] hDev
* @param[in] featureName
* @param[out] pValue 32
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
/**
\~english
* @brief Get the increment of 32bit integer type feature
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pValue Increment of 32bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetInt32Inc(ITKDEVICE hDev, const char* featureName, int32_t* pValue);
/**
\~chinese
* @brief 32
* @param[in] hFeature
* @param[out] pValue 32
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
/**
\~english
* @brief Get the value of 32bit integer type feature
* @param[in] hFeature Camera feature handle
* @param[out] pValue Value of 32bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetInt32(ITKFEATURE hFeature, int32_t* pValue);
/**
\~chinese
* @brief 32
* @param[in] hDev
* @param[in] featureName
* @param[out] pValue 32
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
/**
\~english
* @brief Get the value of 32bit integer type feature
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pValue Value of 32bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetInt32(ITKDEVICE hDev, const char* featureName, int32_t* pValue);
/**
\~chinese
* @brief 32
* @param[in] hFeature
* @param[in] value 32
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @note [ ItkFeatureGetInt32Min , ItkFeatureGetInt32Max ]
value = ItkFeatureGetInt32Min + N* ItkFeatureGetInt32Inc N=0,1,2,
*/
/**
\~english
* @brief Set the value of 32bit integer type feature
* @param[in] hFeature Camera feature handle
* @param[in] value Value of 32bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @note The range of values for the set value must be [ ItkFeatureGetInt32Min , ItkFeatureGetInt32Max ],
value should also satisfy the condition of value = ItkFeatureGetInt32Min + N* ItkFeatureGetInt32Inc , N=0,1,2,
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureSetInt32(ITKFEATURE hFeature, int32_t value);
/**
\~chinese
* @brief 32
* @param[in] hDev
* @param[in] featureName
* @param[in] value 32
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @note [ ItkDevGetInt32Min , ItkDevGetInt32Max ]
value = ItkDevGetInt32Min + N* ItkDevGetInt32Inc N=0,1,2,
*/
/**
\~english
* @brief Set the value of 32bit integer type feature
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[in] value Value of 32bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @note The range of values for the set value must be [ ItkDevGetInt32Min , ItkDevGetInt32Max ],
value should also satisfy the condition of value = ItkDevGetInt32Min + N* ItkDevGetInt32Inc , N=0,1,2,
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevSetInt32(ITKDEVICE hDev, const char* featureName, int32_t value);
/**
\~chinese
* @brief 64
* @param[in] hFeature
* @param[out] pValue 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetInt64FeatureInfo
*/
/**
\~english
* @brief Get the minimum value of 64bit integer type feature
* @param[in] hFeature Camera feature handle
* @param[out] pValue Minimum value of 64bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetInt64FeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetInt64Min(ITKFEATURE hFeature, int64_t* pValue);
/**
\~chinese
* @brief 64
* @param[in] hDev
* @param[in] featureName
* @param[out] pValue 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetInt64FeatureInfo
*/
/**
\~english
* @brief Get the minimum value of 64bit integer type feature
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pValue Minimum value of 64bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetInt64FeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetInt64Min(ITKDEVICE hDev, const char* featureName, int64_t* pValue);
/**
\~chinese
* @brief 64
* @param[in] hFeature
* @param[out] pValue 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetInt64FeatureInfo
*/
/**
\~english
* @brief Get the maximum value of 64bit integer type feature
* @param[in] hFeature Camera feature handle
* @param[out] pValue Maximum value of 64bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetInt64FeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetInt64Max(ITKFEATURE hFeature, int64_t* pValue);
/**
\~chinese
* @brief 64
* @param[in] hDev
* @param[in] featureName
* @param[out] pValue 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetInt64FeatureInfo
*/
/**
\~english
* @brief Get the maximum value of 64bit integer type feature
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pValue Maximum value of 64bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetInt64FeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetInt64Max(ITKDEVICE hDev, const char* featureName, int64_t* pValue);
/**
\~chinese
* @brief 64
* @param[in] hFeature
* @param[out] pValue 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetInt64FeatureInfo
*/
/**
\~english
* @brief Get the increment of 64bit integer type feature
* @param[in] hFeature Camera feature handle
* @param[out] pValue Increment of 64bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetInt64FeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetInt64Inc(ITKFEATURE hFeature, int64_t* pValue);
/**
\~chinese
* @brief 64
* @param[in] hDev
* @param[in] featureName
* @param[out] pValue 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetInt64FeatureInfo
*/
/**
\~english
* @brief Get the increment of 64bit integer type feature
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pValue Increment of 64bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetInt64FeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetInt64Inc(ITKDEVICE hDev, const char* featureName, int64_t* pValue);
/**
\~chinese
* @brief 64
* @param[in] hFeature
* @param[out] pValue 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetInt64
*/
/**
\~english
* @brief Get the value of 64bit integer type feature
* @param[in] hFeature Camera feature handle
* @param[out] pValue Value of 64bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetInt64 instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetInt64(ITKFEATURE hFeature, int64_t* pValue);
/**
\~chinese
* @brief 64
* @param[in] hFeature
* @param[in] value 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @note [ ItkFeatureGetInt64Min , ItkFeatureGetInt64Max ]
value = ItkFeatureGetInt64Min + N* ItkFeatureGetInt64Inc N=0,1,2,
* @deprecated 使 ItkDevSetInt64
*/
/**
\~english
* @brief Set the value of 64bit integer type feature
* @param[in] hFeature Camera feature handle
* @param[in] value Value of 64bit integer type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @note The range of values for the set value must be [ ItkFeatureGetInt64Min , ItkFeatureGetInt64Max ],
value should also satisfy the condition of value = ItkFeatureGetInt64Min + N* ItkFeatureGetInt64Inc , N=0,1,2,
* @deprecated This interface is obsolete, please use ItkDevSetInt64 instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureSetInt64(ITKFEATURE hFeature, int64_t value);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pValue 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetDoubleFeatureInfo
*/
/**
\~english
* @brief Get the minimum value of double type feature
* @param[in] hFeature Camera feature handle
* @param[out] pValue Minimum value of 64bit double type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetDoubleMin(ITKFEATURE hFeature, double* pValue);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[out] pValue 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetDoubleFeatureInfo
*/
/**
\~english
* @brief Get the minimum value of double type feature
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pValue Minimum value of 64bit double type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetDoubleMin(ITKDEVICE hDev, const char* featureName, double* pValue);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pValue 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetDoubleFeatureInfo
*/
/**
\~english
* @brief Get the maximum value of double type feature
* @param[in] hFeature Camera feature handle
* @param[out] pValue Maximum value of 64bit double type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetDoubleMax(ITKFEATURE hFeature, double* pValue);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[out] pValue 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetDoubleFeatureInfo
*/
/**
\~english
* @brief Get the maximum value of double type feature
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pValue Maximum value of 64bit double type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetDoubleMax(ITKDEVICE hDev, const char* featureName, double* pValue);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pValue 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetDoubleFeatureInfo
*/
/**
\~english
* @brief Get the increment value of double type feature
* @param[in] hFeature Camera feature handle
* @param[out] pValue Increment of 64bit double type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetDoubleInc(ITKFEATURE hFeature, double* pValue);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[out] pValue 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetDoubleFeatureInfo
*/
/**
\~english
* @brief Get the increment value of double type feature
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pValue Increment of 64bit double type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetDoubleInc(ITKDEVICE hDev, const char* featureName, double* pValue);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pValue 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetDouble
*/
/**
\~english
* @brief Get value of double type feature
* @param[in] hFeature Camera feature handle
* @param[out] pValue Value of 64bit double type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetDouble instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetDouble(ITKFEATURE hFeature, double* pValue);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[in] value 64
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @note [ ItkFeatureGetDoubleMin , ItkFeatureGetDoubleMax ]
* @deprecated 使 ItkDevSetDouble
*/
/**
\~english
* @brief Set value of double type feature
* @param[in] hFeature Camera feature handle
* @param[in] value Value of 64bit double type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @note The range of values for the set value must be [ ItkFeatureGetDoubleMin , ItkFeatureGetDoubleMax ].
* @deprecated This interface is obsolete, please use ItkDevSetDouble instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureSetDouble(ITKFEATURE hFeature, double value);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pValue
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetDoubleFeatureInfo
*/
/**
\~english
* @brief Get the precision of double type
* @param[in] hFeature Camera feature handle
* @param[out] pValue Precision of double type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetDoublePrecision(ITKFEATURE hFeature, int64_t* pValue);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[out] pValue
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetDoubleFeatureInfo
*/
/**
\~english
* @brief Get the precision of double type
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pValue Precision of double type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetDoubleFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetDoublePrecision(ITKDEVICE hDev, const char* featureName, int64_t* pValue);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[in] pValue
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevSetBool
*/
/**
\~english
* @brief Set the value of boolean type feature
* @param[in] hFeature Camera feature handle
* @param[in] pValue Boolean type value
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevSetBool instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureSetBool(ITKFEATURE hFeature, _Bool value);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pValue
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetBool
*/
/**
\~english
* @brief Get the value of boolean type feature
* @param[in] hFeature Camera feature handle
* @param[out] pValue Boolean type value
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetBool instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetBool(ITKFEATURE hFeature, _Bool* pValue);
IKAPC_API ITKSTATUS IKAPC_CC ItkGigEDevWriteFirmware(ITKDEVICE hDev, uint8_t* firmware, uint16_t id);
IKAPC_API ITKSTATUS IKAPC_CC ItkU3VDevWriteFirmware(ITKDEVICE hDev, uint8_t* firmware, uint16_t id);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pBuff
* @param[in,out] pBuffLen
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @note pBuff设置为NULLpBufLen指向的变量将设置为所需的缓冲区大小
* @deprecated 使 ItkDevToString
*/
/**
\~english
* @brief Get the value of string or enumeration type
* @param[in] hFeature Camera feature handle
* @param[out] pBuff Value of string or enumeration type
* @param[in,out] pBuffLen As input, it indicates the maximum length of feature value. As output, it indicates the effective length of feature value
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @note The buffer passed to this function must be sufficient to hold the entire string.
If pBuff is set to NULL when calling this function, the variable pointed to by pBufLen will be set to the desired buffer size.
* @deprecated This interface is obsolete, please use ItkDevToString instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureToString(ITKFEATURE hFeature, char* pBuff, uint32_t* pBuffLen);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[in] pValue
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevFromString
*/
/**
\~english
* @brief Set the value of string or enumeration type
* @param[in] hFeature Camera feature handle
* @param[in] pValue Value of string or enumeration type
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevFromString instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureFromString(ITKFEATURE hFeature, const char* pValue);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] count
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetEnumEntryFeatureInfo
*/
/**
\~english
* @brief Get the number of enumerations with enumeration type feature
* @param[in] hFeature Camera feature handle
* @param[out] count The number of enumeration items for camera feature
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetEnumEntryFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetEnumCount(ITKFEATURE hFeature, uint32_t* pValue);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[out] count
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetEnumEntryFeatureInfo
*/
/**
\~english
* @brief Get the number of enumerations with enumeration type feature
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] count The number of enumeration items for camera feature
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetEnumEntryFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetEnumCount(ITKDEVICE hDev, const char* featureName, uint32_t* pValue);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[in] index [0, ItkFeatureGetEnumCount -1]
* @param[out] enumString
* @param[in,out] stringSize
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetEnumEntryFeatureInfo
*/
/**
\~english
* @brief Get the name of enumerations with enumeration type feature
* @param[in] hFeature Camera feature handle
* @param[in] index Enumeration item index, valid range is [0, ItkFeatureGetEnumCount -1]
* @param[out] enumString Enumeration item name
* @param[in,out] stringSize As input, it indicates the maximum length of enumeration item name. As output, it indicates the valid length of enumeration item name
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetEnumEntryFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC
ItkFeatureGetEnumString(ITKFEATURE hFeature, uint32_t index, char* enumString, uint32_t* pStringSize);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[in] index [0, ItkDevGetEnumCount -1]
* @param[out] enumString
* @param[in,out] stringSize
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetEnumEntryFeatureInfo
*/
/**
\~english
* @brief Get the name of enumerations with enumeration type feature
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[in] index Enumeration item index, valid range is [0, ItkDevGetEnumCount -1]
* @param[out] enumString Enumeration item name
* @param[in,out] stringSize As input, it indicates the maximum length of enumeration item name. As output, it indicates the valid length of enumeration item name
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetEnumEntryFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC
ItkDevGetEnumString(ITKDEVICE hDev, const char* featureName, uint32_t index, char* enumString, uint32_t* pStringSize);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[in] enumString
* @param[out] bAvailable true表示相机支持该枚举项false表示相机不支持该枚举项
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
/**
\~english
* @brief Determine whether the enumeration item exists
* @param[in] hFeature Camera feature handle
* @param[in] enumString Enumeration item name
* @param[out] bAvailable true indicates that the camera supports the enumeration item, while false indicates that the camera does not support the enumeration item
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetEnumIsAvailable(ITKFEATURE hFeature, const char* enumString, _Bool* bAvailable);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[in] enumString
* @param[out] bAvailable true表示相机支持该枚举项false表示相机不支持该枚举项
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
/**
\~english
* @brief Determine whether the enumeration item exists
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[in] enumString Enumeration item name
* @param[out] bAvailable true indicates that the camera supports the enumeration item, while false indicates that the camera does not support the enumeration item
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
*/
IKAPC_API ITKSTATUS IKAPC_CC
ItkDevGetEnumIsAvailable(ITKDEVICE hDev, const char* featureName, const char* enumString, _Bool* bAvailable);
/**
\~chinese
* @brief
* @param[in] hFeature
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevExecuteCommand
*/
/**
\~english
* @brief Execute corresponding commands based on camera feature
* @param[in] hFeature Camera feature handle
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevExecuteCommand instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureExecuteCommand(ITKFEATURE hFeature);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] isDone
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevCommandIsDone
*/
/**
\~english
* @brief Determine whether the command type feature has been executed successfully
* @param[in] hFeature Camera feature handle
* @param[out] isDone Is the execution completed
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevCommandIsDone instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureCommandIsDone(ITKFEATURE hFeature, _Bool* isDone);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] bSelector
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @note
*/
/**
\~english
* @brief Determine whether the feature is selector
* @param[in] hFeature Camera feature handle
* @param[out] bSelector Whether it is selector
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @note If the camera feature is selector, the values of all selected features should be updated when the feature value changes.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureIsSelector(ITKFEATURE hFeature, _Bool* bSelector);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[out] bSelector
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @note
*/
/**
\~english
* @brief Determine whether the feature is selector
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] bSelector Whether it is selector
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @note If the camera feature is selector, the values of all selected features should be updated when the feature value changes.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevIsSelector(ITKDEVICE hDev, const char* featureName, _Bool* bSelector);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pValue
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetSelectedFeatureCounts
*/
/**
\~english
* @brief Get the number of selected features
* @param[in] hFeature Camera feature handle
* @param[out] pValue The number of selected features
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetSelectedFeatureCounts instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetSelectedFeatureCounts(ITKFEATURE hFeature, uint32_t* pValue);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[in] index [0, ItkFeatureGetSelectedFeatureCounts -1]
* @param[out] pBuf
* @param[out] pBufLen
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated 使 ItkDevGetSelectedFeatureName
*/
/**
\~english
* @brief Get the name of the selected feature
* @param[in] hFeature Camera feature handle
* @param[in] index Feature index, valid range is [0, ItkFeatureGetSelectedFeatureCounts -1]
* @param[out] pBuf The name of the selected feature
* @param[out] pBufLen As input, it indicates the maximum length of feature name. As output, it indicates the effective length of feature name
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* - ITKSTATUS_NOT_IMPLEMENT
* - ITKSTATUS_INCOMPATIBLE_FEATURE_TYPE
* @deprecated This interface is obsolete, please use ItkDevGetSelectedFeatureName instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC
ItkFeatureGetSelectedFeatureName(ITKFEATURE hFeature, uint32_t index, char* pBuf, uint32_t* pBufLen);
/**
\~chinese
* @brief
* @param[in] hFeature
* @param[out] pPollingTime
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Polling period for getting camera features
* @param[in] hFeature Camera feature handle
* @param[out] pPollingTime Polling time for camera feature query
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note For read-only features such as camera temperature, it may be necessary to periodically update the feature value to monitor the camera status in real time,
and the polling time indicates the minimum value of the update period.
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkFeatureGetPollingTime(ITKFEATURE hFeature, uint32_t* pPollingTime);
/**
\~chinese
* @brief
* @param[in] hDev
* @param[in] featureName
* @param[out] pPollingTime
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* @deprecated 使 ItkDevGetFeatureInfo
*/
/**
\~english
* @brief Polling period for getting camera features
* @param[in] hDev Camera device handle
* @param[in] featureName Camera feature name
* @param[out] pPollingTime Polling time for camera feature query
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note For read-only features such as camera temperature, it may be necessary to periodically update the feature value to monitor the camera status in real time,
and the polling time indicates the minimum value of the update period.
* @deprecated This interface is obsolete, please use ItkDevGetFeatureInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkDevGetPollingTime(ITKDEVICE hDev, const char* featureName, uint32_t* pPollingTime);
/**
\~chinese
* @brief
* @param[in] hBuffer
* @param[in] prm
* @param[out] pValue
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note prm如下所示
* | prm |
* |----------------------------------------------|
* | ITKBUFFER_PRM_FORMAT |
* | ITKBUFFER_PRM_WIDTH |
* | ITKBUFFER_PRM_HEIGHT |
* | ITKBUFFER_PRM_ADDRESS |
* | ITKBUFFER_PRM_HOST_COUNTER_STAMP |
* | ITKBUFFER_PRM_STATE |
* | ITKBUFFER_PRM_SIGNED |
* | ITKBUFFER_PRM_SIZE |
* | ITKBUFFER_PRM_BLOCK_ID |
* | ITKBUFFER_PRM_READY_LINES |
* | ITKBUFFER_PRM_ERROR_REASON |
* | ITKBUFFER_PRM_RSND_PKT_COUNT |
* | ITKBUFFER_PRM_LOST_PKT_COUNT |
* | ITKBUFFER_PRM_FIND_LINE_RESULT |
* | ITKBUFFER_PRM_BATCH_STATUS_ADDRESS |
* | ITKBUFFER_PRM_BURR_DECTION_RESULT |
* | ITKBUFFER_PRM_BURR_DECTION_RESULT_COORDINATE |
* | ITKBUFFER_PRM_BURR_DECTION_DEBUG |
* | ITKBUFFER_PRM_PAYLOAD_TYPE |
* | ITKBUFFER_PRM_IMAGE_SIZE |
* | ITKBUFFER_PRM_PIXEL_BITS |
* | ITKBUFFER_PRM_CHANNEL_BITS |
* | ITKBUFFER_PRM_BAYER_CONVERT_METHOD |
* @deprecated 使 ItkBufferGetInfo
*/
/**
\~english
* @brief Get buffer parameter
* @param[in] hBuffer Buffer handle
* @param[in] prm Parameter index
* @param[out] pValue Parameter value
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note Readable buffer parameters prm are as follows:
* | Readable Buffer Parameters prm |
* |----------------------------------------------|
* | ITKBUFFER_PRM_FORMAT |
* | ITKBUFFER_PRM_WIDTH |
* | ITKBUFFER_PRM_HEIGHT |
* | ITKBUFFER_PRM_ADDRESS |
* | ITKBUFFER_PRM_HOST_COUNTER_STAMP |
* | ITKBUFFER_PRM_STATE |
* | ITKBUFFER_PRM_SIGNED |
* | ITKBUFFER_PRM_SIZE |
* | ITKBUFFER_PRM_BLOCK_ID |
* | ITKBUFFER_PRM_READY_LINES |
* | ITKBUFFER_PRM_ERROR_REASON |
* | ITKBUFFER_PRM_RSND_PKT_COUNT |
* | ITKBUFFER_PRM_LOST_PKT_COUNT |
* | ITKBUFFER_PRM_FIND_LINE_RESULT |
* | ITKBUFFER_PRM_BATCH_STATUS_ADDRESS |
* | ITKBUFFER_PRM_BURR_DECTION_RESULT |
* | ITKBUFFER_PRM_BURR_DECTION_RESULT_COORDINATE |
* | ITKBUFFER_PRM_BURR_DECTION_DEBUG |
* | ITKBUFFER_PRM_PAYLOAD_TYPE |
* | ITKBUFFER_PRM_IMAGE_SIZE |
* | ITKBUFFER_PRM_PIXEL_BITS |
* | ITKBUFFER_PRM_CHANNEL_BITS |
* | ITKBUFFER_PRM_BAYER_CONVERT_METHOD |
* @deprecated This interface is obsolete, please use ItkBufferGetInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkBufferGetPrm(ITKBUFFER hBuffer, uint32_t prm, void* pValue);
/**
\~chinese
* @brief
* @param[in] hBuffer
* @param[in] prm
* @param[in] value
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note prm如下所示
* | prm |
* |----------------------------------------------|
* | ITKBUFFER_PRM_FORMAT |
* | ITKBUFFER_PRM_WIDTH |
* | ITKBUFFER_PRM_HEIGHT |
* | ITKBUFFER_PRM_ADDRESS |
* | ITKBUFFER_PRM_EXCHANGE_WIDTH_HEIGHT |
* | ITKBUFFER_PRM_BAYER_CONVERT_METHOD |
*/
/**
\~english
* @brief Set buffer parameter
* @param[in] hBuffer Buffer handle
* @param[in] prm Parameter index
* @param[in] value Parameter value
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note Writable buffer parameters prm are as follows:
* | Writable Buffer Parameters prm |
* |----------------------------------------------|
* | ITKBUFFER_PRM_FORMAT |
* | ITKBUFFER_PRM_WIDTH |
* | ITKBUFFER_PRM_HEIGHT |
* | ITKBUFFER_PRM_ADDRESS |
* | ITKBUFFER_PRM_EXCHANGE_WIDTH_HEIGHT |
* | ITKBUFFER_PRM_BAYER_CONVERT_METHOD |
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkBufferSetPrm(ITKBUFFER hBuffer, uint32_t prm, const void* value);
/**
\~chinese
* @brief RGB通道重排列
* @param[in] hSrc
* @param[in] hDst 31/3
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note
* ```
* R1R2R3
* G1G2G3
* B1B2B3
* (R1G1B1)(R2G2B2)(R3G3B3) R4R5R6
* (R4G4B4)(R5G5B5)(R6G6B6) -> G4G5G6
* (R7G7B7)(R8G8B8)(R9G9B9) B4B5B6
* R7R8R9
* G7G8G9
* B7B8B9
* ```
* @deprecated 使 ItkBufferRGBSplitEx
*/
/**
\~english
* @brief RGB channel rearrangement
* @param[in] hSrc Source buffer handle, pixel format must be in color format
* @param[in] hDst Destination buffer handle. The height of the destination buffer image must be three times that of the source buffer image,
and the pixel format size must be one-third that of the source buffer
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* - ITKSTATUS_INVALID_HANDLE
* @note Pixel after rearrangement
* ```
* R1R2R3
* G1G2G3
* B1B2B3
* (R1G1B1)(R2G2B2)(R3G3B3) R4R5R6
* (R4G4B4)(R5G5B5)(R6G6B6) -> G4G5G6
* (R7G7B7)(R8G8B8)(R9G9B9) B4B5B6
* R7R8R9
* G7G8G9
* B7B8B9
* ```
* @deprecated This interface is obsolete, please use ItkBufferRGBSplitEx instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkBufferRGBSplit(ITKBUFFER hSrc, ITKBUFFER hDst);
/**
\~chinese
* @brief 8bit
* @note 8bit压缩图像数据
*/
/**
\~english
* @brief Monochrome packed 8bit
* @note Grayscale 8bit packed image data.
*/
#define ITKBUFFER_VAL_FORMAT_MONO8PACKED (ITKBUFFER_FORMAT(8, 8, 0x28) | ITKBUFFER_FORMAT_COLOR | ITKBUFFER_FORMAT_UNSIGNED )
/**
\~chinese
* @brief RGB彩色压缩8bit
* @note 8bit压缩图像RGB顺序在内存中排列
*/
/**
\~english
* @brief RGB color packed 8bit
* @note Color 8bit packed image data, pixel values are arranged in memory in RGB order.
*/
#define ITKBUFFER_VAL_FORMAT_RGB888PACKED \
(ITKBUFFER_FORMAT(8, 24, 0x29) | ITKBUFFER_FORMAT_COLOR | ITKBUFFER_FORMAT_UNSIGNED )
/**
\~chinese
* @brief BGR彩色压缩8bit
* @note 8bit压缩图像BGR顺序在内存中排列
*/
/**
\~english
* @brief BGR color packed 8bit
* @note Color 8bit packed image data, pixel values are arranged in memory in BGR order.
*/
#define ITKBUFFER_VAL_FORMAT_BGR888PACKED \
(ITKBUFFER_FORMAT(8, 24, 0x2A) | ITKBUFFER_FORMAT_COLOR | ITKBUFFER_FORMAT_UNSIGNED )
#define ITKBUFFER_VAL_BAYER_METHOD_ITEK_V4 \
0x00000030u ///< @brief \~chinese Bayer转换itek_v4方法 \~english Bayer conversion itek_v4 method
/**
\~chinese
* @brief
* @note ,"FrameTriggerIgnored"
*/
/**
\~english
* @brief Frame trigger signal ignores callback event
* @note This event is triggered when the frame trigger signal is ignored, registered by "FrameTriggerIgnored".
*/
#define ITKDEV_VAL_EVENT_TYPE_FRAME_TRIGGER_IGNORE 0x00040000u
/**
\~chinese
* @brief
* @note ,"LineTriggerIgnored"
*/
/**
\~english
* @brief Line trigger signal ignores callback event
* @note This event is triggered when the line trigger signal is ignored, registered by "LineTriggerIgnored".
*/
#define ITKDEV_VAL_EVENT_TYPE_LINE_TRIGGER_IGNORE 0x00080000u
/**
\~chinese
* @brief
* @note ,"FrameTrigger"
*/
/**
\~english
* @brief Frame trigger acquisition callback event
* @note This event is triggered during frame trigger acquisition, registered by "FrameTrigger".
*/
#define ITKDEV_VAL_EVENT_TYPE_FRAME_TRIGGER 0x00100000u
///@{
/**
\~chinese
* @name
*/
/**
\~english
* @name Event information parameter
*/
#define ITKEVENTINFO_PRM_FIRST 0u
#define ITKEVENTINFO_PRM(n, size) ((((n) + ITKDEV_PRM_FIRST) << 16) | (size))
/**
\~chinese
* @brief RO
* @note pValue/value为 uint32_t
*/
/**
\~english
* @brief Event type [RO]
* @note The corresponding pValue/value of this parameter is uint32_t type data.
*/
#define ITKEVENTINFO_PRM_TYPE ITKEVENTINFO_PRM(0, 4)
/**
\~chinese
* @brief RO
* @note pValue/value为 char[128]
*/
/**
\~english
* @brief Feature Name [RO]
* @note The corresponding pValue/value of this parameter is char[128] type data.
*/
#define ITKEVENTINFO_PRM_FEATURE_NAME ITKEVENTINFO_PRM(1, 128)
/**
\~chinese
* @brief RO
* @note pValue/value为 uint64_t
*/
/**
\~english
* @brief Host timestamp [RO]
* @note The corresponding pValue/value of this parameter is uint64_t type data.
*/
#define ITKEVENTINFO_PRM_HOST_TIME_STAMP ITKEVENTINFO_PRM(2, 8)
/**
\~chinese
* @brief RO
* @note pValue/value为 uint64_t
*/
/**
\~english
* @brief Block ID [RO]
* @note The corresponding pValue/value of this parameter is uint64_t type data.
*/
#define ITKEVENTINFO_PRM_BLOCK_ID ITKEVENTINFO_PRM(3, 8)
/**
\~chinese
* @brief RO
* @note pValue/value为 uint64_t
*/
/**
\~english
* @brief Timestamp [RO]
* @note The corresponding pValue/value of this parameter is uint64_t type data.
*/
#define ITKEVENTINFO_PRM_TIMESTAMP ITKEVENTINFO_PRM(4, 8)
/**
\~chinese
* @brief RO
* @note pValue/value为 char[256]
*/
/**
\~english
* @brief Data of event info [RO]
* @note The corresponding pValue/value of this parameter is char[256] type data.
*/
#define ITKEVENTINFO_PRM_DATA ITKEVENTINFO_PRM(5, 256)
///@}
/**
\~chinese
* @brief
* @param[in] hEventInfo
* @param[in] prm
* @param[out] value
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* @note prm可选项如下所示
* | prm |
* |-------------------------------------|
* | ITKEVENTINFO_PRM_TYPE |
* | ITKEVENTINFO_PRM_FEATURE_NAME |
* | ITKEVENTINFO_PRM_HOST_TIME_STAMP |
* | ITKEVENTINFO_PRM_BLOCK_ID |
* | ITKEVENTINFO_PRM_TIMESTAMP |
* | ITKEVENTINFO_PRM_DATA |
* @deprecated 使 ItkEventGetInfo
*/
/**
\~english
* @brief Get event parameter information
* @param[in] hEventInfo Event information handle
* @param[in] prm Event Information Index
* @param[out] value Event information output buffer
* @return
* - ITKSTATUS_OK
* - ITKSTATUS_INVALID_ARG
* @note Event parameters prm options are as follows:
* | Event Parameters prm |
* |-------------------------------------|
* | ITKEVENTINFO_PRM_TYPE |
* | ITKEVENTINFO_PRM_FEATURE_NAME |
* | ITKEVENTINFO_PRM_HOST_TIME_STAMP |
* | ITKEVENTINFO_PRM_BLOCK_ID |
* | ITKEVENTINFO_PRM_TIMESTAMP |
* | ITKEVENTINFO_PRM_DATA |
* @deprecated This interface is obsolete, please use ItkEventGetInfo instead.
*/
IKAPC_API ITKSTATUS IKAPC_CC ItkEventInfoGetPrm(ITKEVENTINFO hEventInfo, uint32_t prm, void* value);
///@{
/**
\~chinese
* @brief
*/
/**
\~english
* @brief paylaod type
*/
#define ITKBUFFER_VAL_IMAGE_PAYLOAD_TYPE 0u ///< @brief \~chinese 相机图像模式 \~english Camera image mode
#define ITKBUFFER_VAL_U3V_IMAGE_EXTENDED_CHUNK_PAYLOAD_TYPE 1u ///< @brief \~chinese U3V相机Chunk模式1 \~english U3V camera chunk mode
#define ITKBUFFER_VAL_U3V_CHUNK_PAYLOAD_TYPE 2u ///< @brief \~chinese U3V相机Chunk模式2 \~english GV camera chunk mode
#define ITKBUFFER_VAL_GV_CHUNK_DATA_PAYLOAD_TYPE 3u ///< @brief \~chinese GV相机Chunk模式 \~english GV camera chunk mode
///@}
#ifdef __cplusplus
}
# ifdef IKAPC_BOOL_DEFINED
# undef _Bool
# undef IKAPC_BOOL_DEFINED
# endif
#endif
#endif
// clang-format on