Previous topicNext topic
Help > .h文件列表 >
KSJObsolete.h

浏览该文件的源代码。

宏定义

#define KSJ_API   __declspec(dllimport)

类型定义

typedef void(__stdcall * KSJ_AWBCALLBACK )(bool bSuccess, int nValueR, int nValueG, int nValueB, void *lpContext)
 定义自动曝光操作结束后的回调函数
typedef void(__stdcall * KSJ_CCCALLBACK )(bool bSuccess, int nRShift, int nGShift, int nBShift, void *lpContext)
typedef void(__stdcall * KSJ_AFCALLBACK )(int nValue, void *lpContext)
 定义自动聚焦评估操作结束后的回调函数

枚举

enum  KSJ_THRESHOLD { KSJ_THRESHOLD_LOW, KSJ_THRESHOLD_HIGH }
 

坏点检测阈值模式

更多...
enum  KSJHueRange {
  KSJ_ALL_HUES, KSJ_RED_HUES, KSJ_YELLOW_HUES, KSJ_GREEN_HUES,
  KSJ_CYAN_HUES, KSJ_BLUE_HUES, KSJ_MAGENTA_HUES
}
 

颜色分量通道枚举类型

更多...
enum  KSJ_SENSORMODE { KSJ_SM_TRIGGER_MODE, KSJ_SM_FREERUN_MODE, KSJ_SM_GRR_MODE }
enum  KSJ_COLORCORRECT {
  KSJ_CC_NONE, KSJ_CC_SHIFTRGB, KSJ_CC_EQRGB, KSJ_CC_EQALL,
  KSJ_CC_WB
}
enum  KSJ_LED { KSJ_IR = 0, KSJ_UV, KSJ_VI }
enum  KSJ_LEDSTATUS { KSJ_OFF = 0, KSJ_ON }
enum  KSJ_FLASHMODE { KSJ_FM_TROW, KSJ_FM_SIMULTANEOUSEXPOSURE, KSJ_FM_SHUTTERWIDTH }
enum  KSJ_WATERMARKMODE { KSJ_WMM_TIMESTAMP, KSJ_WMM_DISTINGUISH_EXTERNAL_TRIGGER, KSJ_WMM_ANALYSIS_EXTERNAL_TRIGGER }
 

水印模式

更多...
enum  KSJ_PREVIEWMODE { PM_RAWDATA, PM_RGBDATA }
 

Preview Mode.

更多...
enum  KSJ_SNAPBUTTONSTATUS { KSJ_UP, KSJ_DOWN }
 

Snap功能引脚状态.

更多...

函数

KSJ_API int __stdcall KSJ_BadPixelCorrectionSetThreshold (int nIndex, unsigned char btLow, unsigned char btHigh)
 KSJ_BadPixelCorrectionSetThreshold.
KSJ_API int __stdcall KSJ_BadPixelCorrectionGetThreshold (int nIndex, unsigned char *pbtLow, unsigned char *pbtHigh)
 KSJ_BadPixelCorrectionGetThreshold.
KSJ_API int __stdcall KSJ_BadPixelCorrectionSet (int nIndex, bool bEnable, KSJ_THRESHOLD Threshold)
 KSJ_BadPixelCorrectionSet.
KSJ_API int __stdcall KSJ_BadPixelCorrectionGet (int nIndex, bool *pbEnable, KSJ_THRESHOLD *pThreshold)
 KSJ_BadPixelCorrectionGet.
KSJ_API int __stdcall KSJ_HueSaturationSet (int nIndex, KSJHueRange HueRange, int nHue, int nSaturation, int nLightness)
 KSJ_HueSaturationSet.
KSJ_API int __stdcall KSJ_HueSaturationGet (int nIndex, KSJHueRange HueRange, int *pnHue, int *pnSaturation, int *pnLightness)
 KSJ_HueSaturationGet.
KSJ_API int __stdcall KSJ_HueSaturationSetEnable (int nIndex, bool bEnable)
 KSJ_HueSaturationSetEnable.
KSJ_API int __stdcall KSJ_HueSaturationGetEnable (int nIndex, bool *pbEnable)
 KSJ_HueSaturationGetEnable.
KSJ_API int __stdcall KSJ_CaptureSetRecover (int nIndex, bool bRecover)
 是否读取超时后恢复相机
KSJ_API int __stdcall KSJ_CaptureGetRecover (int nIndex, bool *pbRecover)
 获取当前关于超时恢复的设置
KSJ_API int __stdcall KSJ_CaptureSetTimeOutEx (int nIndex, unsigned long dwTimeOut, bool bRecover)
 同时设置超时时间及超时后是否恢复相机
KSJ_API int __stdcall KSJ_CaptureGetTimeOutEx (int nIndex, unsigned long *pdwTimeOut, bool *pbRecover)
 获取关于超时和恢复的设置
KSJ_API int __stdcall KSJ_AWBSetCallback (int nIndex, KSJ_AWBCALLBACK fpAWBCallback, void *lpContext)
 定义自动白平衡操作结束后的回调函数，当自动曝光结束时，KSJ开发包会自动调用pfAWBCallback用户指定的回调函数
KSJ_API int __stdcall KSJ_AWBStart (int nIndex, bool bStart, int nMaxCount, int nRTarget, int nGTarget, int nBTarget)
 启动或结束自动曝光操作
KSJ_API int __stdcall KSJ_GammaOn (int nIndex, bool bOn)
 打开或关闭Gamma校正，即影响预览又影响采集
KSJ_API int __stdcall KSJ_SetFixedFrameRate (int nIndex, bool bEnable, float fFrameRate)
 Not Support Now.
KSJ_API int __stdcall KSJ_GetFixedFrameRate (int nIndex, bool *pbEnable, float *pfFrameRate)
KSJ_API int __stdcall KSJ_StrobeDelaySet (int nIndex, unsigned short wDelay)
KSJ_API int __stdcall KSJ_StrobeDelayGet (int nIndex, unsigned short *pwDelay)
KSJ_API int __stdcall KSJ_StrobeDelayGetRange (int nIndex, unsigned short *wMin, unsigned short *wMax)
KSJ_API int __stdcall KSJ_SensorModeSet (int nIndex, KSJ_SENSORMODE SensorMode)
KSJ_API int __stdcall KSJ_SensorModeGet (int nIndex, KSJ_SENSORMODE *SensorMode)
KSJ_API int __stdcall KSJ_ColorCorrectSetCallback (int nIndex, KSJ_CCCALLBACK fpCCCallback, void *lpContext)
KSJ_API int __stdcall KSJ_ColorCorrectSet (int nIndex, KSJ_COLORCORRECT ColorCorrect, int nRTarget, int nGTarget, int nBTarget)
KSJ_API int __stdcall KSJ_ColorCorrectGet (int nIndex, KSJ_COLORCORRECT *pColorCorrect)
KSJ_API int __stdcall KSJ_ColorCorrectGetEx (int nIndex, KSJ_COLORCORRECT *pColorCorrect, int *pnRTarget, int *pnGTarget, int *pnBTarget)
KSJ_API int __stdcall KSJ_ColorCorrectTableSave (int nIndex, const TCHAR *pszFileName)
KSJ_API int __stdcall KSJ_ColorCorrectTableLoad (int nIndex, const TCHAR *pszFileName)
KSJ_API int __stdcall KSJ_IsColorCorrectTableLoad (int nIndex, bool *bLoad)
KSJ_API int __stdcall KSJ_LedSetStatus (int nIndex, KSJ_LED Led, KSJ_LEDSTATUS LedStatus)
KSJ_API int __stdcall KSJ_LedGetStatus (int nIndex, KSJ_LED Led, KSJ_LEDSTATUS *pLedStatus)
KSJ_API int __stdcall KSJ_FlashSetMode (int nIndex, KSJ_FLASHMODE FlashMode)
KSJ_API int __stdcall KSJ_FlashGetMode (int nIndex, KSJ_FLASHMODE *pFlashMode)
KSJ_API int __stdcall KSJ_AESetCallback (int nIndex, KSJ_AECALLBACK pfAECallback, void *lpContext)
 定义通过KSJ_AEStartEx启动的自动曝光操作的回调函数，当自动曝光进行每一次调节时，KSJ开发包会自动调用pfAECallbackEx用户指定的回调函数
KSJ_API int __stdcall KSJ_AEStart (int nIndex, bool bStart, int nMaxCount, int nTarget)
 启动或结束自动曝光操作
KSJ_API int __stdcall KSJ_AFSetRegion (int nIndex, int nX, int nY, int nW, int nH)
 设置自动聚焦评估的参考区域，这个区域是相对预览图像的位置
KSJ_API int __stdcall KSJ_AFShowRegion (int nIndex, bool bShow)
 是否显示自动聚焦的参考区域
KSJ_API int __stdcall KSJ_AFGetRegion (int nIndex, int *pnX, int *pnY, int *pnW, int *pnH, bool *pbShow)
 获取自动聚焦的参考区域及显示状态，这个区域是相对预览图像的位置
KSJ_API int __stdcall KSJ_AFSetCallback (int nIndex, KSJ_AFCALLBACK fpAFCallback, void *lpContext)
 定义自动聚焦评估值计算结束后的回调函数
KSJ_API int __stdcall KSJ_AFStart (int nIndex, bool bStart)
 开始或停止自动聚焦自动评估操作
KSJ_API int __stdcall KSJ_AECSetEnable (int nIndex, bool bEnable)
 开启或关闭AEC功能
KSJ_API int __stdcall KSJ_AECGetEnable (int nIndex, bool *pbEnable)
 获取AEC功能是否开启
KSJ_API int __stdcall KSJ_AECSetRange (int nIndex, unsigned short usMin, unsigned short usMax)
 设置AEC的调节范围
KSJ_API int __stdcall KSJ_AECGetRange (int nIndex, unsigned short *pusMin, unsigned short *pusMax)
 获取AEC的调节范围
KSJ_API int __stdcall KSJ_AECGetCur (int nIndex, unsigned short *usCur)
 得到AEC的当前曝光行
KSJ_API int __stdcall KSJ_AGCSetEnable (int nIndex, bool bEnable)
 开启或关闭AGC功能
KSJ_API int __stdcall KSJ_AGCGetEnable (int nIndex, bool *pbEnable)
 获取AGC功能是否开启
KSJ_API int __stdcall KSJ_AGCSetRange (int nIndex, unsigned short usMin, unsigned short usMax)
 设置AGC的调节范围
KSJ_API int __stdcall KSJ_AGCGetRange (int nIndex, unsigned short *pusMin, unsigned short *pusMax)
 获取AGC的调节范围
KSJ_API int __stdcall KSJ_AGCGetCur (int nIndex, unsigned short *pusCur)
 得到AGC的当前增益值
KSJ_API int __stdcall KSJ_GammaLutFileDownload (int nIndex, const TCHAR *pszKtbFile)
 KSJ_GammaLutFileDownload.
KSJ_API int __stdcall KSJ_GammaLutDataDownload (int nIndex, unsigned short *pData, int nWords)
 KSJ_GammaLutDataDownload.
KSJ_API int __stdcall KSJ_GammaLutSetEnable (int nIndex, bool bEnable)
 KSJ_GammaLutSetEnable.
KSJ_API int __stdcall KSJ_GammaLutGetEnable (int nIndex, bool *pbEnable)
 KSJ_GammaLutGetEnable.
KSJ_API int __stdcall KSJ_WaterMarkSetMode (int nIndex, KSJ_WATERMARKMODE WaterMarkMode)
 设置水印模式（新版本水印已经不支持水印模式设置，默认KSJ_WMM_TIMESTAMP）
KSJ_API int __stdcall KSJ_WaterMarkGetMode (int nIndex, KSJ_WATERMARKMODE *pWaterMarkMode)
 获取水印模式（新版本水印已经不支持水印模式设置，默认KSJ_WMM_TIMESTAMP）
KSJ_API int __stdcall KSJ_GetErrorInfo (IN int nErrorNo, OUT TCHAR pszErrorInfo[256])
 KSJ_GetErrorInfo.
KSJ_API int __stdcall KSJ_PreviewGetFrameRate (int nIndex, float *fFrameRate)
 KSJ_PreviewGetFrameRate.
KSJ_API int __stdcall KSJ_PreviewGetPausedData (int nIndex, unsigned char *pData)
 获取暂停时的那一帧图像数据
KSJ_API int __stdcall KSJ_PreviewPause (int nIndex, bool bPause)
 KSJ_PreviewPause.
KSJ_API int __stdcall KSJ_PreviewGetPausedDataEx (int nIndex, unsigned char *pData, int *pnWidth, int *pnHeight, int *pnBitCount)
 获取暂停时的那一帧图像数据
KSJ_API int __stdcall KSJ_PreviewGetDefaultMode (int nIndex, KSJ_PREVIEWMODE *pPreviewMode)
 获取相机默认的预览模式 参数：
KSJ_API int __stdcall KSJ_PreviewSetMode (int nIndex, KSJ_PREVIEWMODE PreviewMode)
 KSJ_PreviewSetMode.
KSJ_API int __stdcall KSJ_PreviewGetMode (int nIndex, KSJ_PREVIEWMODE *pPreviewMode)
 KSJ_PreviewGetMode.
KSJ_API int __stdcall KSJ_PreviewSetCalibration (int nIndex, bool bEnable)
 KSJ_PreviewSetCalibration.
KSJ_API int __stdcall KSJ_PreviewGetCalibration (int nIndex, bool *pbEnable)
 KSJ_PreviewGetCalibration.
KSJ_API int __stdcall KSJ_CaptureSetCalibration (int nIndex, bool bEnable)
 KSJ_CaptureSetCalibration.
KSJ_API int __stdcall KSJ_CaptureGetCalibration (int nIndex, bool *pbEnable)
 KSJ_CaptureGetCalibration.
KSJ_API int __stdcall KSJ_SnapButtonStatus (int nIndex, KSJ_SNAPBUTTONSTATUS *pSnapButtonStatus)
 读取Snap功能引脚状态
KSJ_API int __stdcall KSJ_HelperStretchBmp (unsigned char *pData, int nWidth, int nHeight, int nBitCount, unsigned char *pStretchData, int nStretchWidth, int nStretchHeight)
 KSJ_HelperStretchBmp.
KSJ_API int __stdcall KSJ_HelperGetBmpFileHeaderSize (int nBitCount, int *pnTotalBytes)
 KSJ_HelperGetBmpFileHeaderSize.
KSJ_API int __stdcall KSJ_HelperGetBmpFileHeader (int nWidth, int nHeight, int nBitCount, void *pHeader)
 KSJ_HelperGetBmpFileHeader.
KSJ_API int __stdcall KSJ_CaptureRgbDataToClipboard (int nIndex)
 KSJ_CaptureRgbDataToClipboard.
KSJ_API int __stdcall KSJ_GammaLutInfoProgram (int nIndex, unsigned short wValue)
KSJ_API int __stdcall KSJ_GammaLutInfoReadout (int nIndex, unsigned short *pValue)
KSJ_API int __stdcall KSJ_GammaLutFileProgram (int nIndex, TCHAR *pszFile)
KSJ_API int __stdcall KSJ_GammaLutDataProgram (int nIndex, unsigned short *pData, int nWords)
KSJ_API int __stdcall KSJ_GammaLutDataReadout (int nIndex, unsigned short *pData, int *pnWords)
KSJ_API int __stdcall KSJ_StreamReadRawData (int nIndex, unsigned char *pRawData)
 相机工作在流模式时，采集一帧原始或黑白图像数据
KSJ_API int __stdcall KSJ_StreamReadRgbData (int nIndex, unsigned char *pRgbData)
 相机工作在流模式时，采集一帧8位原始或灰度图像或24，32位彩色数据图像
KSJ_API int __stdcall KSJ_StreamReadRawDataEx (int nIndex, unsigned char *pRawData, unsigned int *pDataSize)
 相机工作在流模式时，采集一帧原始或黑白图像数据
KSJ_API int __stdcall KSJ_StreamReadRgbDataEx (int nIndex, unsigned char *pRgbData, unsigned int *pDataSize)
 相机工作在流模式时，采集一帧8位原始或灰度图像或24，32位彩色数据图像

宏定义文档

#define KSJ_API   __declspec(dllimport)

类型定义文档

typedef void(__stdcall * KSJ_AWBCALLBACK)(bool bSuccess, int nValueR, int nValueG, int nValueB, void *lpContext)

定义自动曝光操作结束后的回调函数

-----------------------------------------------------------------------------

参数:
bSuccess [out] 传回自动白平衡操作是否调节到用户设定的目标值（参考KSJ_AEStart函数），TRUE，表示自动白平衡调节到达了目标值，FALSE，表示自动白平衡超过用户设定的调节次数，没有达到目标值
nValueR [out] 在自动白平衡调节结束后，红增益的设置值
nValueG [out] 在自动白平衡调节结束后，绿增益的设置值
nValueB [out] 在自动白平衡调节结束后，蓝增益的设置值
lpContext [out] 用户上下文指针，这个指针是用户调用KSJ_AWBSetCallback时传入的上下文指针
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用，不再推荐使用, 请用KSJApiMatrix.h内函数

-----------------------------------------------------------------------------

typedef void(__stdcall * KSJ_CCCALLBACK)(bool bSuccess, int nRShift, int nGShift, int nBShift, void *lpContext)
typedef void(__stdcall * KSJ_AFCALLBACK)(int nValue, void *lpContext)

定义自动聚焦评估操作结束后的回调函数

-----------------------------------------------------------------------------

参数:
nValue [out] 聚焦评估值(0-10200)
lpContext [out] 用户上下文指针，这个指针是用户调用KSJ_AFSetCallback时传入的上下文指针
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

枚举类型文档

enum KSJ_THRESHOLD

坏点检测阈值模式

枚举值:
KSJ_THRESHOLD_LOW 

低阈值模式

KSJ_THRESHOLD_HIGH 

高阈值模式

enum KSJHueRange

颜色分量通道枚举类型

枚举值:
KSJ_ALL_HUES 

基础通道，所有通道的调节值需要加上该通道值

KSJ_RED_HUES 

红色通道

KSJ_YELLOW_HUES 

黄色通道

KSJ_GREEN_HUES 

绿色通道

KSJ_CYAN_HUES 

青色通道

KSJ_BLUE_HUES 

蓝色通道

KSJ_MAGENTA_HUES 

洋红色通道

enum KSJ_SENSORMODE
枚举值:
KSJ_SM_TRIGGER_MODE 
KSJ_SM_FREERUN_MODE 
KSJ_SM_GRR_MODE 
enum KSJ_COLORCORRECT
枚举值:
KSJ_CC_NONE 
KSJ_CC_SHIFTRGB 
KSJ_CC_EQRGB 
KSJ_CC_EQALL 
KSJ_CC_WB 
enum KSJ_LED
枚举值:
KSJ_IR 
KSJ_UV 
KSJ_VI 
enum KSJ_LEDSTATUS
枚举值:
KSJ_OFF 
KSJ_ON 
enum KSJ_FLASHMODE
枚举值:
KSJ_FM_TROW 
KSJ_FM_SIMULTANEOUSEXPOSURE 
KSJ_FM_SHUTTERWIDTH 
enum KSJ_WATERMARKMODE

水印模式

枚举值:
KSJ_WMM_TIMESTAMP 
KSJ_WMM_DISTINGUISH_EXTERNAL_TRIGGER 
KSJ_WMM_ANALYSIS_EXTERNAL_TRIGGER 
enum KSJ_PREVIEWMODE

Preview Mode.

枚举值:
PM_RAWDATA 
PM_RGBDATA 

预览原始数据，对于黑白相机，必须设置为PM_RAWDATA

预览24位或32位彩色数据（由Bayer模式决定）

enum KSJ_SNAPBUTTONSTATUS

Snap功能引脚状态.

枚举值:
KSJ_UP 
KSJ_DOWN 

按键处于闭合状态

按键处于开启状态

函数文档

KSJ_API int __stdcall KSJ_BadPixelCorrectionSetThreshold ( int  nIndex,
unsigned char  btLow,
unsigned char  btHigh 
)

KSJ_BadPixelCorrectionSetThreshold.

-----------------------------------------------------------------------------

设置软件坏点校正的相邻阈值及次相邻阈值

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
btLow [in] 设置相邻像素的比较阈值，默认20
btHigh [in] 设置相邻像素的比较阈值，默认50
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用
  • 如果该像素与相邻像素的差值大于btLow，并且它与次相邻相邻像素的差值大于btHigh，那么该点将被认为是坏点。
  • 该设置仅对软件坏点校正生效，如果硬件支持怀点校正，那么使用内部预设值进行硬件坏点校正，不会执行软件坏点校正。
-----------------------------------------------------------------------------
KSJ_API int __stdcall KSJ_BadPixelCorrectionGetThreshold ( int  nIndex,
unsigned char *  pbtLow,
unsigned char *  pbtHigh 
)

KSJ_BadPixelCorrectionGetThreshold.

-----------------------------------------------------------------------------

获取软件坏点校正的阈值设置

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pbtLow [out] 返回相邻像素的比较阈值
pbtHigh [out] 返回次相邻像素的比较阈值
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_BadPixelCorrectionSet ( int  nIndex,
bool  bEnable,
KSJ_THRESHOLD  Threshold 
)

KSJ_BadPixelCorrectionSet.

-----------------------------------------------------------------------------

设置软件坏点校正的相邻阈值及次相邻阈值

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
bEnable [in] 是否加入坏点补偿算法
Threshold [in] 选取的阈值，参考KSJ_THRESHOLD说明
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用
  • 坏点校正设置及阈值设置，低阈值会过滤更多的坏点
  • 如果相机硬件支持坏点校正，硬件将使用对应的阈值模式进行坏点校正。
  • 执行该函数以后，软件坏点校正的相邻阈值及次相邻阈值将更新为内部预设值，如果需要使用自定义的阈值，需要在该函数之后，再设置（KSJ_BadPixelCorrectionSetThreshold()）
-----------------------------------------------------------------------------
KSJ_API int __stdcall KSJ_BadPixelCorrectionGet ( int  nIndex,
bool *  pbEnable,
KSJ_THRESHOLD *  pThreshold 
)

KSJ_BadPixelCorrectionGet.

-----------------------------------------------------------------------------

获取相机当前的坏点补偿信息

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pbEnable [in] 返回是否加入坏点补偿算法
pThreshold [in] 返回当前坏点补偿算法所选取的阈值模式，只针对支持硬件坏点校正的相机有效
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_HueSaturationSet ( int  nIndex,
KSJHueRange  HueRange,
int  nHue,
int  nSaturation,
int  nLightness 
)

KSJ_HueSaturationSet.

-----------------------------------------------------------------------------

设置各个颜色分量的色度、饱和度、亮度

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
HueRange [in] 要设置的颜色分量类型
nHue [in] 设置指定颜色分量的色度，取值范围-180 ~ 180
nSaturation [in] 设置指定颜色的饱和度，取值范围-100 ~ 100
nLightness [in] 设置指定颜色分量的亮度，取值范围-100 ~ 100
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用
  • 该算法由软件执行，可能会影响RGB彩色图像的采集效率和预览帧率
-----------------------------------------------------------------------------
KSJ_API int __stdcall KSJ_HueSaturationGet ( int  nIndex,
KSJHueRange  HueRange,
int *  pnHue,
int *  pnSaturation,
int *  pnLightness 
)

KSJ_HueSaturationGet.

-----------------------------------------------------------------------------

获取各个颜色分量的色度、饱和度、亮度

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
HueRange [in] 要设置的颜色分量类型
pnHue [out] 获取指定颜色分量的色度
pnSaturation [out] 获取指定颜色的饱和度
pnLightness [out] 获取指定颜色分量的亮度
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_HueSaturationSetEnable ( int  nIndex,
bool  bEnable 
)

KSJ_HueSaturationSetEnable.

-----------------------------------------------------------------------------

使能或关闭颜色分量调节功能

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
bEnable [in] ture 开启颜色分量调节，false 关闭颜色分量调节
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_HueSaturationGetEnable ( int  nIndex,
bool *  pbEnable 
)

KSJ_HueSaturationGetEnable.

-----------------------------------------------------------------------------

获取颜色分量调节功能是否使能

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pbEnable [out] 返回颜色分量调节功能是否使能，ture 开启颜色分量调节，false 关闭颜色分量调节
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_CaptureSetRecover ( int  nIndex,
bool  bRecover 
)

是否读取超时后恢复相机

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
bRecover [in] 读取超时后是否恢复相机,true恢复,false不恢复
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_CaptureGetRecover ( int  nIndex,
bool *  pbRecover 
)

获取当前关于超时恢复的设置

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pbRecover [out] 获取设置读取超时后是否恢复相机,true恢复,false不恢复
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_CaptureSetTimeOutEx ( int  nIndex,
unsigned long  dwTimeOut,
bool  bRecover 
)

同时设置超时时间及超时后是否恢复相机

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
dwTimeOut [in] 设置超时时间,单位为毫秒
bRecover [in] 读取超时后是否恢复相机,true恢复,false不恢复
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_CaptureGetTimeOutEx ( int  nIndex,
unsigned long *  pdwTimeOut,
bool *  pbRecover 
)

获取关于超时和恢复的设置

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pdwTimeOut [out] 获取读取一帧图像的超时时间，单位为毫秒
pbRecover [out] 获取设置读取超时后是否恢复相机,true恢复,false不恢复
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AWBSetCallback ( int  nIndex,
KSJ_AWBCALLBACK  fpAWBCallback,
void *  lpContext 
)

定义自动白平衡操作结束后的回调函数，当自动曝光结束时，KSJ开发包会自动调用pfAWBCallback用户指定的回调函数

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
fpAWBCallback [in] 用户定义的自动白平衡回调函数指针（参考KSJ_AWBCALLBACK函数的定义）
lpContext [in] 回调函数的上下文指针
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用，不再推荐使用, 请用KSJApiMatrix.h内函数

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AWBStart ( int  nIndex,
bool  bStart,
int  nMaxCount,
int  nRTarget,
int  nGTarget,
int  nBTarget 
)

启动或结束自动曝光操作

-----------------------------------------------------------------------------

参数:
bSuccess [out] 传回自动白平衡操作是否调节到用户设定的目标值（参考KSJ_AEStart函数），TRUE，表示自动白平衡调节到达了目标值，FALSE，表示自动白平衡超过用户设定的调节次数，没有达到目标值
bStart [in] TRUE 开始自动白平衡调节，FALSE 终止或结束自动白平衡调节
nMaxCount [out] 设定最多调节几次就结束。如果在用户设置的次数内白平衡调节没有达到用户设定的目标值，回调函数会提示自动白平衡失败
nRTarget [out] 调节到的目标红分量值（0-255）
nGTarget [out] 调节到的目标绿分量值（0-255）
nBTarget [out] 调节到的目标蓝分量值（0-255）
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用，不再推荐使用, 请用KSJApiMatrix.h内函数

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_GammaOn ( int  nIndex,
bool  bOn 
)

打开或关闭Gamma校正，即影响预览又影响采集

KSJ_API int __stdcall KSJ_SetFixedFrameRate ( int  nIndex,
bool  bEnable,
float  fFrameRate 
)

Not Support Now.

KSJ_API int __stdcall KSJ_GetFixedFrameRate ( int  nIndex,
bool *  pbEnable,
float *  pfFrameRate 
)
KSJ_API int __stdcall KSJ_StrobeDelaySet ( int  nIndex,
unsigned short  wDelay 
)
KSJ_API int __stdcall KSJ_StrobeDelayGet ( int  nIndex,
unsigned short *  pwDelay 
)
KSJ_API int __stdcall KSJ_StrobeDelayGetRange ( int  nIndex,
unsigned short *  wMin,
unsigned short *  wMax 
)
KSJ_API int __stdcall KSJ_SensorModeSet ( int  nIndex,
KSJ_SENSORMODE  SensorMode 
)
KSJ_API int __stdcall KSJ_SensorModeGet ( int  nIndex,
KSJ_SENSORMODE *  SensorMode 
)
KSJ_API int __stdcall KSJ_ColorCorrectSetCallback ( int  nIndex,
KSJ_CCCALLBACK  fpCCCallback,
void *  lpContext 
)
KSJ_API int __stdcall KSJ_ColorCorrectSet ( int  nIndex,
KSJ_COLORCORRECT  ColorCorrect,
int  nRTarget,
int  nGTarget,
int  nBTarget 
)
KSJ_API int __stdcall KSJ_ColorCorrectGet ( int  nIndex,
KSJ_COLORCORRECT *  pColorCorrect 
)
KSJ_API int __stdcall KSJ_ColorCorrectGetEx ( int  nIndex,
KSJ_COLORCORRECT *  pColorCorrect,
int *  pnRTarget,
int *  pnGTarget,
int *  pnBTarget 
)
KSJ_API int __stdcall KSJ_ColorCorrectTableSave ( int  nIndex,
const TCHAR *  pszFileName 
)
KSJ_API int __stdcall KSJ_ColorCorrectTableLoad ( int  nIndex,
const TCHAR *  pszFileName 
)
KSJ_API int __stdcall KSJ_IsColorCorrectTableLoad ( int  nIndex,
bool *  bLoad 
)
KSJ_API int __stdcall KSJ_LedSetStatus ( int  nIndex,
KSJ_LED  Led,
KSJ_LEDSTATUS  LedStatus 
)
KSJ_API int __stdcall KSJ_LedGetStatus ( int  nIndex,
KSJ_LED  Led,
KSJ_LEDSTATUS *  pLedStatus 
)
KSJ_API int __stdcall KSJ_FlashSetMode ( int  nIndex,
KSJ_FLASHMODE  FlashMode 
)
KSJ_API int __stdcall KSJ_FlashGetMode ( int  nIndex,
KSJ_FLASHMODE *  pFlashMode 
)
KSJ_API int __stdcall KSJ_AESetCallback ( int  nIndex,
KSJ_AECALLBACK  pfAECallback,
void *  lpContext 
)

定义通过KSJ_AEStartEx启动的自动曝光操作的回调函数，当自动曝光进行每一次调节时，KSJ开发包会自动调用pfAECallbackEx用户指定的回调函数

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pfAECallback [in] 用户定义的自动曝光回调函数指针（参考KSJ_AECALLBACK函数的定义）
lpContext [in] 回调函数的上下文指针
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用, 不再推荐使用，请使用KSJ_AESetCallbackEx代替

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AEStart ( int  nIndex,
bool  bStart,
int  nMaxCount,
int  nTarget 
)

启动或结束自动曝光操作

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
bStart [in] 设定最多调节几次就结束。如果在用户设置的次数内曝光调节没有达到用户设定的目标值，回调函数会提示自动曝光失败
nMaxCount [in] TRUE 开始自动曝光调节，FALSE 终止或结束自动曝光调节
nTarget [in] 调节到的目标亮度值（0-255）
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用, 不再推荐使用，请使用KSJ_AEStartEx代替

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AFSetRegion ( int  nIndex,
int  nX,
int  nY,
int  nW,
int  nH 
)

设置自动聚焦评估的参考区域，这个区域是相对预览图像的位置

设置聚焦评估区域 -----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
nX [in] 相对于无缩放预览图像的左上角水平像素偏移
nY [in] 相对于无缩放预览图像的左上角垂直像素偏移
nW [in] 相对于无缩放预览图像的自动曝光区域的宽度以像素为单位
nH [in] 相对于无缩放预览图像的自动曝光区域的高度以像素为单位
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AFShowRegion ( int  nIndex,
bool  bShow 
)

是否显示自动聚焦的参考区域

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
bShow [in] 是否显示自动聚焦参考区域
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AFGetRegion ( int  nIndex,
int *  pnX,
int *  pnY,
int *  pnW,
int *  pnH,
bool *  pbShow 
)

获取自动聚焦的参考区域及显示状态，这个区域是相对预览图像的位置

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pnX [out] 返回相对于无缩放预览图像的左上角水平像素偏移
pnY [out] 返回相对于无缩放预览图像的左上角垂直像素偏移
pnW [out] 返回相对于无缩放预览图像的自动曝光区域的宽度以像素为单位
pnH [out] 返回相对于无缩放预览图像的自动曝光区域的高度以像素为单位
pbShow [out] 参考区域是否显示
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AFSetCallback ( int  nIndex,
KSJ_AFCALLBACK  fpAFCallback,
void *  lpContext 
)

定义自动聚焦评估值计算结束后的回调函数

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
fpAFCallback [in] 用户定义的自动聚焦评估回调函数指针（参考KSJ_AFCALLBACK函数的定义）
lpContext [in] 回调函数的上下文指针
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AFStart ( int  nIndex,
bool  bStart 
)

开始或停止自动聚焦自动评估操作

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
bStart [in] TRUE 开始自动聚焦评估计算，FALSE 终止或结束自动聚焦评估计算
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AECSetEnable ( int  nIndex,
bool  bEnable 
)

开启或关闭AEC功能

硬件自动曝光 -----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
bEnable [in] true 开启AEC功能，false 关闭AEC功能
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AECGetEnable ( int  nIndex,
bool *  pbEnable 
)

获取AEC功能是否开启

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pbEnable [out] true AEC功能已经开启，false AEC功能已经关闭
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AECSetRange ( int  nIndex,
unsigned short  usMin,
unsigned short  usMax 
)

设置AEC的调节范围

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
usMin [in] AEC调节下限（曝光行）
usMax [in] AEC调节上限（曝光行）
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AECGetRange ( int  nIndex,
unsigned short *  pusMin,
unsigned short *  pusMax 
)

获取AEC的调节范围

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pusMin [out] 返回AEC调节下限（曝光行）
pusMax [out] 返回AEC调节上限（曝光行）
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AECGetCur ( int  nIndex,
unsigned short *  usCur 
)

得到AEC的当前曝光行

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
usCur [out] 返回AEC当前值（曝光行）
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AGCSetEnable ( int  nIndex,
bool  bEnable 
)

开启或关闭AGC功能

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
bEnable [in] true 开启AGC功能，false 关闭AGC功能
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AGCGetEnable ( int  nIndex,
bool *  pbEnable 
)

获取AGC功能是否开启

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pbEnable [out] true AGC功能已经开启，false AGC功能已经关闭
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AGCSetRange ( int  nIndex,
unsigned short  usMin,
unsigned short  usMax 
)

设置AGC的调节范围

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
usMin [in] AGC调节增益下限
usMax [in] AGC调节增益上限
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AGCGetRange ( int  nIndex,
unsigned short *  pusMin,
unsigned short *  pusMax 
)

获取AGC的调节范围

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pusMin [out] 返回AGC调节增益下限
pusMax [out] 返回AGC调节增益上限
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_AGCGetCur ( int  nIndex,
unsigned short *  pusCur 
)

得到AGC的当前增益值

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pusCur [out] 返回AGC当前增益值
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_GammaLutFileDownload ( int  nIndex,
const TCHAR *  pszKtbFile 
)

KSJ_GammaLutFileDownload.

----------------------------------------------------------------------------- 以ktb文件形式，下载Gamma LUT查找表至相机 参数：

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pszKtbFile [in] .ktb文件路径
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用 -----------------------------------------------------------------------------
KSJ_API int __stdcall KSJ_GammaLutDataDownload ( int  nIndex,
unsigned short *  pData,
int  nWords 
)

KSJ_GammaLutDataDownload.

----------------------------------------------------------------------------- 加载用户自定义的Gamma LUT查找表数据 参数：

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pData [out] 指向查找表数据的指针，每个元素为双字节
nWords [in] 查找表数据个数
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用 -----------------------------------------------------------------------------
KSJ_API int __stdcall KSJ_GammaLutSetEnable ( int  nIndex,
bool  bEnable 
)

KSJ_GammaLutSetEnable.

----------------------------------------------------------------------------- 使能Gamma LUT查找表功能 参数：

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
bEnable [in] 设置是否使Gamma LUT功能生效
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用 -----------------------------------------------------------------------------
KSJ_API int __stdcall KSJ_GammaLutGetEnable ( int  nIndex,
bool *  pbEnable 
)

KSJ_GammaLutGetEnable.

----------------------------------------------------------------------------- 获取Gamma LUT查找表是否使能 参数：

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pbEnable [out] 返回是否Gamma LUT功能已生效
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用 -----------------------------------------------------------------------------
KSJ_API int __stdcall KSJ_WaterMarkSetMode ( int  nIndex,
KSJ_WATERMARKMODE  WaterMarkMode 
)

设置水印模式（新版本水印已经不支持水印模式设置，默认KSJ_WMM_TIMESTAMP）

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
WaterMarkMode [in] 设置水印模式
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_WaterMarkGetMode ( int  nIndex,
KSJ_WATERMARKMODE *  pWaterMarkMode 
)

获取水印模式（新版本水印已经不支持水印模式设置，默认KSJ_WMM_TIMESTAMP）

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pWaterMarkMode [out] 获取当前水印模式
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_GetErrorInfo ( IN int  nErrorNo,
OUT TCHAR  pszErrorInfo[256] 
)

KSJ_GetErrorInfo.

-----------------------------------------------------------------------------

获得错误的详细信息字符串

参数:
nErrorNo [in] 传入错误代码, 请参考 KSJCode.h 中错误码的定义。
pszErrorInfo[out] 传出错误代码信息字符串
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
可以在任意时刻调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_PreviewGetFrameRate ( int  nIndex,
float *  fFrameRate 
)

KSJ_PreviewGetFrameRate.

-----------------------------------------------------------------------------

获取帧速

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
fFrameRate [out] 返回当前视频流的帧速
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_PreviewGetPausedData ( int  nIndex,
unsigned char *  pData 
)

获取暂停时的那一帧图像数据

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pData [out] 由用户提供的数据区域，函数调用返回后，此区域会被填充暂停时的图像数据
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_PreviewPause ( int  nIndex,
bool  bPause 
)

KSJ_PreviewPause.

-----------------------------------------------------------------------------

暂停或继续视频流

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
bPause [in] true 暂停视频流，false 继续视频流
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_PreviewGetPausedDataEx ( int  nIndex,
unsigned char *  pData,
int *  pnWidth,
int *  pnHeight,
int *  pnBitCount 
)

获取暂停时的那一帧图像数据

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pData [out] 由用户提供的数据区域，函数调用返回后，此区域会被填充暂停时的图像数据
pnWidth [out] 返回图像的宽度（像素）
pnHeight[out] 返回图像的高度（像素）
pnBitCount[out] 返回图像的每个像素位数（8，24或32）
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_PreviewGetDefaultMode ( int  nIndex,
KSJ_PREVIEWMODE *  pPreviewMode 
)

获取相机默认的预览模式 参数：

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pPreviewMode [out] 获取相机默认的预览模式（参考KSJ_PREVIEWMODE定义）
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_PreviewSetMode ( int  nIndex,
KSJ_PREVIEWMODE  PreviewMode 
)

KSJ_PreviewSetMode.

-----------------------------------------------------------------------------

设置视频流为原始采集数据还是RGB 24位或32位彩色数据格式，一般用户无需设置

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
PreviewMode [in] 设置的预览模式（参考KSJ_PREVIEWMODE定义）
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_PreviewGetMode ( int  nIndex,
KSJ_PREVIEWMODE *  pPreviewMode 
)

KSJ_PreviewGetMode.

-----------------------------------------------------------------------------

获取相机的当前预览模式

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pPreviewMode [out] 获取当前的预览模式（参考KSJ_PREVIEWMODE定义）
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_PreviewSetCalibration ( int  nIndex,
bool  bEnable 
)

KSJ_PreviewSetCalibration.

----------------------------------------------------------------------------- 对预览流是否进行畸变矫正处理 参数：

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
bEnable [in] 为true时时开启畸变矫正, false时关闭畸变矫正
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用 -----------------------------------------------------------------------------
KSJ_API int __stdcall KSJ_PreviewGetCalibration ( int  nIndex,
bool *  pbEnable 
)

KSJ_PreviewGetCalibration.

----------------------------------------------------------------------------- 获取当前预览流是否进行畸变矫正处理 参数：

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pbEnable [out] 返回畸变矫正对于预览的使能状态
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用 -----------------------------------------------------------------------------
KSJ_API int __stdcall KSJ_CaptureSetCalibration ( int  nIndex,
bool  bEnable 
)

KSJ_CaptureSetCalibration.

----------------------------------------------------------------------------- 对采集是否进行畸变矫正处理 参数：

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
bEnable [in] 为true时时开启畸变矫正, false时关闭畸变矫正
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用 -----------------------------------------------------------------------------
KSJ_API int __stdcall KSJ_CaptureGetCalibration ( int  nIndex,
bool *  pbEnable 
)

KSJ_CaptureGetCalibration.

----------------------------------------------------------------------------- 获取采集时是否进行畸变矫正处理 参数：

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pbEnable [out] 返回畸变矫正对于采集的使能状态
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用 -----------------------------------------------------------------------------
KSJ_API int __stdcall KSJ_SnapButtonStatus ( int  nIndex,
KSJ_SNAPBUTTONSTATUS *  pSnapButtonStatus 
)

读取Snap功能引脚状态

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pSnapButtonStatus [out] 返回Snap功能引脚状态, KSJ_SNAPBUTTONSTATUS类型
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_HelperStretchBmp ( unsigned char *  pData,
int  nWidth,
int  nHeight,
int  nBitCount,
unsigned char *  pStretchData,
int  nStretchWidth,
int  nStretchHeight 
)

KSJ_HelperStretchBmp.

----------------------------------------------------------------------------- 将pData(宽度为nWidth, 高度为nHeight, 比特位数为nBitCount)的图像数据缩放为宽度为nStretchWidh, 高度为nStretchHeight的数据并填充到用户分配的pStretchData缓冲区,比特位数不变 参数：

参数:
pData [in] 输入图像的数据指针
nWidth [in] 输入图像的宽度
nHeight [in] 输入图像的高度
nBitCount [in] 输入图像的比特深度
pStretchData [out] 输出图像保存内存地址指针
nStretchWidth [out] 输出图像的宽度
nStretchHeight [out] 输出图像的高度
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用 -----------------------------------------------------------------------------
KSJ_API int __stdcall KSJ_HelperGetBmpFileHeaderSize ( int  nBitCount,
int *  pnTotalBytes 
)

KSJ_HelperGetBmpFileHeaderSize.

----------------------------------------------------------------------------- 根据图像的比特深度得到BMP图像的文件头,信息头,及颜色表总的字节数目 参数：

参数:
nBitCount [in] 图像的比特深度
pnTotalBytes [out] BMP的文件头，信息头，以及颜色表的总字节数
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用 -----------------------------------------------------------------------------
KSJ_API int __stdcall KSJ_HelperGetBmpFileHeader ( int  nWidth,
int  nHeight,
int  nBitCount,
void *  pHeader 
)

KSJ_HelperGetBmpFileHeader.

----------------------------------------------------------------------------- 得到BMP图像的文件头和信息头 参数：

参数:
nWidth [in] 图像的宽度
nHeight [in] 图像的高度
nBitCount [in] 图像的比特深度
pHeader [out] BMP的文件头和信息头数据保存的地址指针
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用 -----------------------------------------------------------------------------
KSJ_API int __stdcall KSJ_CaptureRgbDataToClipboard ( int  nIndex  ) 

KSJ_CaptureRgbDataToClipboard.

----------------------------------------------------------------------------- 采集一帧图像到系统剪贴板，从一个相机采集一帧图像并放到系统的剪切板 参数：

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用 -----------------------------------------------------------------------------
KSJ_API int __stdcall KSJ_GammaLutInfoProgram ( int  nIndex,
unsigned short  wValue 
)
KSJ_API int __stdcall KSJ_GammaLutInfoReadout ( int  nIndex,
unsigned short *  pValue 
)
KSJ_API int __stdcall KSJ_GammaLutFileProgram ( int  nIndex,
TCHAR *  pszFile 
)
KSJ_API int __stdcall KSJ_GammaLutDataProgram ( int  nIndex,
unsigned short *  pData,
int  nWords 
)
KSJ_API int __stdcall KSJ_GammaLutDataReadout ( int  nIndex,
unsigned short *  pData,
int *  pnWords 
)
KSJ_API int __stdcall KSJ_StreamReadRawData ( int  nIndex,
unsigned char *  pRawData 
)

相机工作在流模式时，采集一帧原始或黑白图像数据

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pRawData [out] 由用户分配内存空间，用于保存采集数据，采集图像的像素尺寸可以通过KSJ_CaptureGetSize或KSJ_CaptureGetSizeEx函数获得
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_StreamReadRgbData ( int  nIndex,
unsigned char *  pRgbData 
)

相机工作在流模式时，采集一帧8位原始或灰度图像或24，32位彩色数据图像

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pRgbData [out] 由用户分配内存空间，用于保存采集数据，采集图像的像素尺寸可以通过KSJ_CaptureGetSize或KSJ_CaptureGetSizeEx函数获得
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_StreamReadRawDataEx ( int  nIndex,
unsigned char *  pRawData,
unsigned int *  pDataSize 
)

相机工作在流模式时，采集一帧原始或黑白图像数据

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pRawData [out] 由用户分配内存空间，用于保存采集数据，采集图像的像素尺寸可以通过KSJ_CaptureGetSize或KSJ_CaptureGetSizeEx函数获得
pDataSize [out] 返回实际图像数据的大小
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------

KSJ_API int __stdcall KSJ_StreamReadRgbDataEx ( int  nIndex,
unsigned char *  pRgbData,
unsigned int *  pDataSize 
)

相机工作在流模式时，采集一帧8位原始或灰度图像或24，32位彩色数据图像

-----------------------------------------------------------------------------

参数:
nIndex [in] 相机索引（从0开始，最大索引数为:连接到主机的相机数目减一）
pRgbData [out] 由用户分配内存空间，用于保存采集数据，采集图像的像素尺寸可以通过KSJ_CaptureGetSize或KSJ_CaptureGetSizeEx函数获得
pDataSize [out] 返回实际图像数据的大小
返回:
成功返回 RET_SUCCESS(1)。否则返回非1值的错误码, 请参考 KSJCode.h 中错误码的定义。
注意:
调用KSJ_Init函数初始化后调用

-----------------------------------------------------------------------------