福建捷宇电脑科技有限公司 DoccameraOcx 控件参考文档

6

福建捷宇电脑科技有限公司

3.接口说明

3.1.摄像头控制

3.1.1. 显示主视频源

/*************************************************************************/BOOL bStartPlay()/*************************************************************************/* 函数名称：bStartPlay* 功能描述：显示主摄像头视频源* 输入参数：无* 输出参数：无* 返回值： TRUE——成功

FALSE——失败

3.1.2. 显示主视频源（窗口句柄）

/*************************************************************************/BOOL bStartPlayEx(long hwnd)/*************************************************************************/* 函数名称：bStartPlayEx* 功能描述：显示视频源* 输入参数：hwnd——显示视频的窗口句柄* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bStartPlayEx ( hwnd)

3.1.3. 显示主视频源（窗口句柄、可旋转）

/*************************************************************************/BOOL bStartPlayRotateEx(long hwnd,short rotate)/*************************************************************************/* 函数名称：bStartPlayRotateEx* 功能描述：显示视频源* 输入参数：hwnd——显示视频的窗口句柄

rotate——视频旋转角度* 输出参数：无

7

福建捷宇电脑科技有限公司

* 返回值： TRUE——成功FALSE——失败

* 例如： m_cap. bStartPlayRotateEx( hwnd,90)

3.1.4. 显示主视频源（可旋转）

/*************************************************************************/BOOL bStartPlayRotate(short rotate)/*************************************************************************/* 函数名称：bStartPlayRotate* 功能描述：启动视频* 输入参数：rotate——视频旋转角度* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bStartPlayRotate (90);

动态旋转视频：

先 m_cap.bStopPlay(); 再运行 m_cap. bStartPlayRotate (180);

3.1.5. 显示副视频源（可旋转）

/*************************************************************************/BOOL bStartPlay2 (short sRotate)/*************************************************************************/* 函数名称：bStartPlay2* 功能描述：显示副视频源* 输入参数：sRotate——旋转角度* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bStartPlay2 (0);

3.1.6. 显示副视频源（窗口句柄、可旋转）

/*************************************************************************/BOOL bStartPlay2Ex(long hwnd, short sRotate)/*************************************************************************/* 函数名称：bStartPlay2Ex* 功能描述：显示副视频源

8

福建捷宇电脑科技有限公司

* 输入参数：hwnd——显示视频的窗口句柄sRotate——旋转角度

* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bStartPlay2 (hwnd ,90);

3.1.7. 暂停视频源

/*************************************************************************/BOOL bPausePlay()/*************************************************************************/* 函数名称：bPausePlay* 功能描述：暂停视频源的显示* 输入参数：无* 输出参数：无* 返回值： TRUE——成功

FALSE——失败

3.1.8. 停止视频源

/*************************************************************************/BOOL bStopPlay()/*************************************************************************/* 函数名称：bStopPlay* 功能描述：停止视频源的显示* 输入参数：无* 输出参数：无* 返回值： TRUE——成功

FALSE——失败

3.1.9. 显示人像合并

/*************************************************************************/BOOL bStartFace();/*************************************************************************/* 函数名称：bStartFace* 功能描述：主副摄像头合并显示* 输入参数：无* 输出参数：无* 返回值： TRUE——成功

9

福建捷宇电脑科技有限公司

FALSE——失败

3.1.10. 停止人像合并

/*************************************************************************/BOOL bStopFace();/*************************************************************************/* 函数名称： bStopFace* 功能描述：停止人像合并的显示* 输入参数：无* 输出参数：无* 返回值： TRUE——成功

FALSE——失败

3.1.11. 视频源放大操作

/*************************************************************************/void vZoomOut();/*************************************************************************/* 函数名称： vZoomOut* 功能描述：放大视频源* 输入参数：无* 输出参数：无* 返回值： 无

3.1.12. 视频源缩小操作

/*************************************************************************/void vZoomIn();/*************************************************************************/* 函数名称： vZoomIn* 功能描述：缩小视频源* 输入参数：无* 输出参数：无* 返回值： 无

3.1.13. 视频源还原操作

/*************************************************************************/void vZoomOriginal();/*************************************************************************/* 函数名称： vZoomOriginal* 功能描述：还原视频源

10

福建捷宇电脑科技有限公司

* 输入参数：无* 输出参数：无* 返回值： 无

3.2.参数设置

3.2.1. 设置视频源参数

/*************************************************************************/void displayVideoPara()/*************************************************************************/* 函数名称：displayVideoPara* 功能描述：显示并设置视频源参数* 输入参数：无* 输出参数：无* 返回值： 无

3.2.2. 设置 PIN参数

/*************************************************************************/void vSetCapturePin ()/*************************************************************************/* 函数名称：vSetCapturePin* 功能描述：设置 PIN参数* 输入参数：无* 输出参数：无* 返回值： 无

3.2.3. 设置 DPI

/*************************************************************************/void vSetDPI(long DPI_X, long DPI_Y)/*************************************************************************/* 函数名称：vSetDPI* 功能描述：设置 DPI* 输入参数：DPI_X——横向 DPI（默认 96）

DPI_Y——纵向 DPI（默认 96）* 输出参数：无* 返回值： 无

11

福建捷宇电脑科技有限公司

3.2.4. 获取 DPI

/*************************************************************************/void vGetDPI(long* DPI_X, long* DPI_Y)/*************************************************************************/* 函数名称：vGetDPI* 功能描述：获取 DPI* 输入参数：无* 输出参数：DPI_X——横向 DPI（默认 96）

DPI_Y——纵向 DPI（默认 96）* 返回值： 无

3.2.5. 设置当前旋转角度

/*************************************************************************/void vSetRotate(short Rotate)/*************************************************************************/* 函数名称：vSetRotate* 功能描述：设置当前旋转角度* 输入参数：Rotate——当前旋转角度（默认 0）* 输出参数：无* 返回值： 无

3.2.6. 获取当前旋转角度

/*************************************************************************/short iGetRotate()/*************************************************************************/* 函数名称：iGetRotate* 功能描述：获取当前旋转角度* 输入参数：无* 输出参数：无* 返回值： 当前旋转角度（默认 0度）

12

福建捷宇电脑科技有限公司

3.2.7. 设置二值化参数

/*************************************************************************/void vSetTIFPara(float fRPara, float fGPara, float fBPara, float fWBPara)/*************************************************************************/* 函数名称：vSetTIFPara* 功能描述：设置二值化参数* 输入参数：fRPara——红色参数（默认 0.3）

fGPara——绿色参数（默认 0.59）fBPara——蓝色参数（默认 0.11）fWBPara——阀值参数（默认 0.2）

* 输出参数：无* 返回值： 无

3.2.8. 获取当前二值化参数

/*************************************************************************/void vGetTIFPara(float* fRPara, float* fGPara, float* fBPara, float* fWBPara)/*************************************************************************/* 函数名称：vGetTIFPara* 功能描述：获取当前二值化参数* 输入参数：无* 输出参数：fRPara——红色参数（默认 0.3）

fGPara——绿色参数（默认 0.59）fBPara——蓝色参数（默认 0.11）fWBPara——阀值参数（默认 0.2）

* 返回值： 无

3.2.9. 设置拍照模式

/*************************************************************************/BOOL bSetMode(short iMode)/*************************************************************************/* 函数名称：bSetMode* 功能描述：设置拍照模式* 输入参数：iMode——拍照模式

0—支持鼠标框选模式（默认模式）1—定义固定大小拍照模式2—定义固定大小身份证拍照模式3—自动寻边

13

福建捷宇电脑科技有限公司

4—自动寻边身份证拍照模式* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bSetMode(0);//设置为默认鼠标可以框选的模式* 备注： 如果设置 bSetMode(1)后，要用 bSetImageArea ()函数定义拍照区域。

3.2.10. 设置拍照区域大小

/*************************************************************************/BOOL bSetImageArea(short iX1, short iY1, short iX2, short iY2)/*************************************************************************/* 函数名称：bSetImageArea* 功能描述：设置拍照区域大小（宽和高分为 10000份））* 输入参数：iX1——拍照区域的左边 Left（1－10000）

iY1——拍照区域的上边 Top（1－10000）iX2——拍照区域的右边 Right（1－10000）iY2——拍照区域的下边 Bottom（1－10000）

* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bSetMode(1);

m_cap. bSetImageArea (100，100，9900，9900);* 备注： 调用该接口前要先调用 bSetMode(1)函数，设置为 1模式。

3.2.11. 设置图片宽高分辨率的缩放率

/*************************************************************************/BOOL bSetIamgeXYZoom(float fImageXYZoom)/*************************************************************************/* 函数名称：bSetIamgeXYZoom* 功能描述：设置图片宽高分辨率的缩放率* 输入参数：fImageXYZoom——宽高分辨率的缩放率（默认值为 1.0）* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bSetIamgeXYZoom (0.8);//把图片分辨率缩小为原来的 0.8倍

14

福建捷宇电脑科技有限公司

3.2.12. 设置图片的压缩率

/*************************************************************************/void vSetImageQuality(short sImageQuality)/*************************************************************************/* 函数名称：vSetImageQuality* 功能描述：设置图片保存的压缩率 （拍.BMP图片本函数无效）* 输入参数：sImageQuality——图片保存的压缩率（区间：1－100，默认值：70）* 输出参数：无* 返回值： 无* 例如： m_cap. vSetImageQuality (70);

3.2.13. 获取图片保存的压缩率

/*************************************************************************/short sGetImageQuality()/*************************************************************************/* 函数名称：sGetImageQuality* 功能描述：获取图片保存的压缩率（区间：1－100）* 输入参数：无* 输出参数：无* 返回值： 图片保存的压缩率（区间：1－100）* 例如： short sQuality = m_cap. sGetImageQuality ();

3.2.14. 设置自动矫正

/*************************************************************************/void vSetSkewFlag (BOOL flag)/*************************************************************************/* 函数名称：vSetSkewFlag* 功能描述：设置自动矫正标志* 输入参数：flag——自动矫正标志（TRUE：矫正，FALSE：不矫正）* 输出参数：无* 返回值： 无

3.2.15. 获取自动矫正

/*************************************************************************/BOOL bGetSkewFlag()

15

福建捷宇电脑科技有限公司

/*************************************************************************/* 函数名称：bGetSkewFlag* 功能描述：获取自动矫正标志* 输入参数：无* 输出参数：无* 返回值： TRUE——矫正

FALSE——不矫正

3.2.16. 设置黑边去除

/*************************************************************************/void vSetDelHBFlag (BOOL bFlag)/*************************************************************************/* 函数名称：vSetSkewFlag* 功能描述：设置黑边去除标志* 输入参数：bFlag——黑边去除标志（TRUE：去除，FALSE：不去除）* 输出参数：无* 返回值： 无

3.2.17. 获取黑边去除

/*************************************************************************/BOOL bGetDelHBFlag ()/*************************************************************************/* 函数名称：bGetDelHBFlag* 功能描述：获取黑边去除标志* 输入参数：无* 输出参数：无* 返回值： TRUE——去除

FALSE——不去除

3.2.18. 设置视频压缩类型

/*************************************************************************/void vSetVideoCompressType (short compressType)/*************************************************************************/* 函数名称：vSetVideoCompressType* 功能描述：设置视频压缩类型* 输入参数：compressType——压缩类型

16

福建捷宇电脑科技有限公司

1—MJPG2—YUY23—RGB240/其它—按默认类型

* 输出参数：无* 返回值： 无* 备注： 自动对焦设备用 1

3.2.19. 设置主摄像头分辨率

/*************************************************************************/void vSetResolution(short resolutionType)/*************************************************************************/* 函数名称：vSetResolution* 功能描述：设置分辨率* 输入参数：resolutionType——分辨率类型

1—320*2402—640*4803—800*6004—1024*7685—1600*12006—2048*15367—2592*19440/其它—按设备默认值分辨率

* 输出参数：无* 返回值： 无* 注意：调用设置分辨率后，需要重启摄像头

captrue.vSetResolution(3);captrue.bStopPlay();captrue.bStartPlay();

3.2.20. 设置视频压缩格式

/*************************************************************************/void vSetVideoCompressTypeEx(short devIndex, short compressType)/*************************************************************************/* 函数名称：vSetVideoCompressTypeEx* 功能描述：设置视频压缩格式* 输入参数：devIndex——摄像头索引，１，主摄像头，２副摄像头

compressType——视频压缩格式（可不设置，则按默认MJPG）1—MJPG

17

福建捷宇电脑科技有限公司

2—YUY23—RGB24

* 输出参数：无* 返回值： 无

3.2.21. 设置摄像头分辨率

/*************************************************************************/void vSetResolutionEx(short devIndex, short resolutionType);/*************************************************************************/* 函数名称：vSetResolutionEx* 功能描述：设置分辨率* 输入参数：devIndex——摄像头索引，１，主摄像头，２副摄像头

resolutionType——分辨率类型1—320*2402—640*4803—800*6004—1024*7685—1600*12006—2048*15367—2592*19448—3648*27369—4608*34560/其它—按设备默认值分辨率

* 输出参数：无* 返回值： 无

3.2.22. 设置曝光相对值

/*************************************************************************/void vSetExposure(short iExposure)/*************************************************************************/* 函数名称：vSetExposure* 功能描述：设置曝光相对值（打开视频后调用）* 输入参数：iExposure——曝光相对值（区间：0－100）* 输出参数：无* 返回值： 无* 例如： m_cap. vSetExposure(50);

18

福建捷宇电脑科技有限公司

3.2.23. 设置亮度相对值

/*************************************************************************/void vSetBrightness(short iBrightness)/*************************************************************************/* 函数名称：vSetBrightness* 功能描述：设置亮度相对值（打开视频后调用）* 输入参数：iBrightness——亮度相对值（区间：0－100）* 输出参数：无* 返回值： 无* 例如： m_cap. vSetBrightness(50);

3.2.24. 设置对比度相对值

/*************************************************************************/void vSetContrast(short iContrast)/*************************************************************************/* 函数名称：vSetContrast* 功能描述：设置对比度相对值（打开视频后调用）* 输入参数：iContrast——对比度相对值（区间：0－100）* 输出参数：无* 返回值： 无* 例如： m_cap. vSetContrast(50);

3.2.25. A3图片切割 2个 A4

/*************************************************************************/void vSetA3To2A4Flag(BOOL flag)/*************************************************************************/* 函数名称：vSetA3To2A4Flag* 功能描述：将 A3图片切割成 2个 A4（拍照之前调用）* 输入参数：flag——是否切割标志（TRUE：是，FALSE：否）* 输出参数：无* 返回值： 无* 例如： m_cap. vSetA3To2A4Flag(true);

3.2.26. 获取设备 ID

/*************************************************************************/

19

福建捷宇电脑科技有限公司

BSTR sGetDevicesId()/*************************************************************************/* 函数名称：sGetDevicesId* 功能描述：获取设备 ID* 输入参数：无* 输出参数：无* 返回值： 设备 ID

3.2.27. 设置裁边模式

/*************************************************************************/void vSetCutEdgeMode(BOOL mode)/*************************************************************************/* 函数名称：vSetCutEdgeMode* 功能描述：设置裁边模式* 输入参数：mode——是否设置裁边* 输出参数：无* 返回值： 无

3.2.28. 设置裁边大小

/*************************************************************************/void vSetCutEdgeSize(long left, long right, long top, long bottom)/*************************************************************************/* 函数名称：vSetCutEdgeSize* 功能描述：设置裁边大小* 输入参数：left——左边裁剪大小

right——右边裁剪大小top——顶部裁剪大小bottom——底部裁剪大小

* 输出参数：无* 返回值： 无

3.2.29. 获取焦点

/*************************************************************************/BOOL bGetFocus(long * curValue, long * minValue, long * maxValue,

long * defaultValue, long * step)/*************************************************************************/* 函数名称：bGetFocus

20

福建捷宇电脑科技有限公司

* 功能描述：获取焦点（自动对焦设备使用）* 输入参数：curValue——当前值

minValue——最小值maxValue——最大值defaultValue——默认值step——

* 输出参数：TRUE——成功FALSE——失败

* 返回值： 无

3.2.30. 设置焦点

/*************************************************************************/void vSetFocus(long focusValue, BOOL autoFlag)/*************************************************************************/* 函数名称：vSetFocus* 功能描述：设置焦点（自动对焦设备使用）* 输入参数：focusValue——焦点值

autoFlag——是否自动* 输出参数：无* 返回值： 无

3.2.31. 分割多页

/*************************************************************************/BOOL bSaveSplitImage(LPCTSTR filePath, LPCTSTR fileName)/*************************************************************************/* 函数名称：bSaveSplitImage* 功能描述：分割多页* 输入参数：filePath——保存路径

fileName——文件名称，(不含后缀名.jpg)* 输出参数：无* 返回值： 无

备注：拆分后的图片会在图片名后加_1.jpg---_n.jpg

3.2.32. 设置视频显示模式

/*************************************************************************/void vSetVideoDispMode(short mode)

21

福建捷宇电脑科技有限公司

/*************************************************************************/* 函数名称：vSetVideoDispMode* 功能描述：设置视频显示模式* 输入参数：mode——显示模式：0 - 4:3比例显示，1 – 自适应* 输出参数：无* 返回值： 无

3.3.图片处理

3.3.1. 保存 BMP图片

/*************************************************************************/BOOL bSaveBMP(LPCTSTR filePath, LPCTSTR fileName)/*************************************************************************/* 函数名称：bSaveBMP* 功能描述：保存为 BMP图片* 输入参数：filePath——保存图片的路径

Filename——保存图片的名称（不用包含后缀名）* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap.bSaveBMP("D:\","bmpImage");

3.3.2. 保存 JPG图片

/*************************************************************************/BOOL bSaveJPG(LPCTSTR filePath, LPCTSTR fileName)/*************************************************************************/* 函数名称：bSaveJPG* 功能描述：保存为 JPG图片* 输入参数：filePath——保存图片的路径

filename——保存图片的名称（不用包含后缀名）* 输出参数：无* 返回值： TRUE——成功

FALSE——失败

3.3.3. 保存 PNG图片

/*************************************************************************/

22

福建捷宇电脑科技有限公司

BOOL bSavePNG(LPCTSTR filePath, LPCTSTR fileName)/*************************************************************************/* 函数名称：bSavePNG* 功能描述：保存为 PNG图片* 输入参数：filePath——保存图片的路径

filename——保存图片的名称（不用包含后缀名）* 输出参数：无* 返回值： TRUE——成功

FALSE——失败

3.3.4. 保存 TIF图片

/*************************************************************************/BOOL bSaveTIF (LPCTSTR filePath, LPCTSTR fileName)/*************************************************************************/* 函数名称：bSaveTIF* 功能描述：保存为 1位 TIF 图片* 输入参数：filePath——保存图片的路径

filename——保存图片的名称（不用包含后缀名）* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bSaveTIFEx ("D:\","tif");

3.3.5. 保存黑白 TIF图片（支持多页）

/*************************************************************************/BOOL bSaveTIFEx(LPCTSTR filePath, LPCTSTR fileName, short iMulPageFlag)/*************************************************************************/* 函数名称：bSaveTIFEx* 功能描述：保存黑白 TIF 图片* 输入参数：filePath——保存图片的路径

filename——保存图片的名称（不用包含后缀名）iMulPageFlag——是否多页（1：多页，0：单页）

* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bSaveTIFEx ("D:\","tif",0);

m_cap. bSaveTIFEx ("D:\","mulTif",1);

23

福建捷宇电脑科技有限公司

3.3.6. 保存彩色 TIF图片（支持多页）

/*************************************************************************/BOOL bSaveTIF24Bit(LPCTSTR filePath, LPCTSTR fileName, short iMulPageFlag)/*************************************************************************/* 函数名称：bSaveTIF24Bit* 功能描述：保存彩色 TIF 图片* 输入参数：filePath——保存图片的路径

filename——保存图片的名称（不用包含后缀名）iMulPageFlag——是否多页（1：多页，0：单页）

* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bSaveTIF24Bit("D:\","tif",0);

m_cap. bSaveTIF24Bit("D:\","mulTif",1);

3.3.7. 保存灰度图和 TIF图片

/*************************************************************************/BOOL bSaveGrayAndTIF(LPCTSTR grayPath, LPCTSTR grayName,

LPCTSTR tifPath, LPCTSTR tifName )/*************************************************************************/* 函数名称：bSaveGrayAndTIF* 功能描述：同时保存为灰度图和 TIF 图片* 输入参数：grayPath——保存 Gray图片的路径

grayName——保存 Gray图片的名称（不用包含后缀名，后缀名为.BMP）tifPath——保存 TIF图片的路径tifName——保存 TIF图片的名称(不用包含后缀名，后缀名为.TIF）

* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap.bSaveGrayAndTIF("D:\","Gray1","D:\","Gray1_FIT");

24

福建捷宇电脑科技有限公司

3.3.8. 保存为 TIF并进行 OCR识别

/*************************************************************************/BOOL bSaveTifToOCR(LPCTSTR TifPath, LPCTSTR TifName)/*************************************************************************/* 函数名称：bSaveTifToOCR* 功能描述：保存为 Tif并进行 OCR识别* 输入参数：TifPath——保存 Tif图片的路径

TifName——保存 Tif图片的名称（不用包含后缀名）* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bSaveTifToOCR ("D:\","TifImage");

3.3.9. 保存灰度图

/*************************************************************************/BOOL bSaveGray (LPCTSTR grayPath, LPCTSTR grayName)/*************************************************************************/* 函数名称：bSaveGray* 功能描述：保存灰度图（8位，DPI值 96）* 输入参数：grayPath——保存 Gray图片的路径

grayName——保存 Gray图片的名称（不用包含后缀名，后缀名为.JPG）* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap.bSaveGray("D:\","Gray1");

3.3.10. 保存灰度图（支持 8、24位）

/*************************************************************************/BOOL bSaveGrayEx(LPCTSTR path, LPCTSTR name,short bit)/*************************************************************************/* 函数名称：bSaveGrayEx* 功能描述：保存灰度图（DPI值设置有效）* 输入参数：path——保存 Gray图片的路径

name——保存 Gray图片的名称（不用包含后缀名，后缀名为.JPG）bit——位数（8位或 24位）

* 输出参数：无* 返回值： TRUE——成功

25

福建捷宇电脑科技有限公司

FALSE——失败* 例如： m_cap.bSaveGrayEx("D:\","Gray8",8);

m_cap.bSaveGrayEx("D:\","Gray24",24);

3.3.11. 保存黑白 JPG图片

/*************************************************************************/BOOL bSaveTifJPG(LPCTSTR filePath, LPCTSTR fileName)/*************************************************************************/* 函数名称：bSaveTifJPG* 功能描述：保存黑白 JPG图片* 输入参数：filePath——保存图片的路径

filename——保存图片的名称（不用包含后缀名）* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bSaveTifJPG ("D:\","tifJpg");

3.3.12. 自动扫描

/*************************************************************************/void AutoScan (short sImageType, LPCTSTR filePath, LPCTSTR fileName)/*************************************************************************/* 函数名称：AutoScan* 功能描述：自动扫描* 输入参数：sImageType——图片类型（1：JPG，0：TIF）

filePath——保存图片的路径filename——保存图片的名称（不用包含后缀名）

* 输出参数：无* 返回值： 无* 备注： 自动连续扫描时，文件名为：filePath+ filename+001-999+.jpg/tif

3.3.13. 自动扫描（返回拍摄张数）

/*************************************************************************/short iAutoScan (short sImageType, LPCTSTR filePath, LPCTSTR fileName)/*************************************************************************/* 函数名称：AutoScan* 功能描述：自动扫描

26

福建捷宇电脑科技有限公司

* 输入参数：sImageType——图片类型（1：JPG，0：TIF）filePath——保存图片的路径filename——保存图片的名称（不用包含后缀名）

* 输出参数：无* 返回值： 拍摄张数* 备注： 自动连续扫描时，文件名为：filePath+ filename+001-999+.jpg/tif

3.3.14. 获取 JPG图像文件的 BASE64数据

/*************************************************************************/BSTR sGetBase64()/*************************************************************************/* 函数名称：sGetBase64* 功能描述：获取 jpg图像文件（24位）的 Base64编码数据* 输入参数：无* 输出参数：无* 返回值： 返回 Base64编码后的数据*/

3.3.15. 获取指定图像类型文件的 BASE64数据

/*************************************************************************/BSTR sGetImageBase64 (short imageType)/*************************************************************************/* 函数名称：sGetImageBase64* 功能描述：获取指定图像类型文件的 Base64编码数据* 输入参数：imageType——图像类型

1—BMP2—GIF3—JPG4—PNG5—TIF（黑白）其它—JPG

* 输出参数：无* 返回值： 返回 Base64编码后的数据

3.3.16. 图片旋转

/*************************************************************************/BOOL bRotateJpgImage (LPCTSTR pathName, short rotate)

27

福建捷宇电脑科技有限公司

/*************************************************************************/* 函数名称：bRotateJpgImage* 功能描述：图片旋转* 输入参数：pathName——图片的路径

rotate——图片旋转角度* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bRotateJpgImage ("D:\",90);

3.3.17. 设置水印参数

/*************************************************************************/void vSetWaterPrint(short iWaterPrintFlag, LPCTSTR sWaterPrintInfo, short iAddTimeFlag)/*************************************************************************/* 函数名称：vSetWaterPrint* 功能描述：设置水印参数信息* 输入参数：iWaterPrintFlag——水印开关（0：不打水印，1：打水印）

sWaterPrintInfo ——水印内容iAddTimeFlag——水印内容加时间（0：不加，1：加）

* 输出参数：无* 返回值： 无* 例如： m_cap. vSetWaterPrint (1,"水印内容",1);

3.3.18. 设置水印字体大小

/*************************************************************************/void vSetWaterPrintFontSize(short fontSize)/*************************************************************************/* 函数名称：vSetWaterPrintFontSize* 功能描述：设置水印字体大小* 输入参数：fontSize——水印字体大小* 输出参数：无* 返回值：无* 例如： m_cap. vSetWaterPrintFontSize (100);

3.3.19. 设置水印字体颜色

/*************************************************************************/void vSetWaterPrintFontColor(long rgb)

28

福建捷宇电脑科技有限公司

/*************************************************************************/* 函数名称：vSetWaterPrintFontColor* 功能描述：设置水印字体颜色* 输入参数：rgb——水印字体颜色（0x000000-0xFFFFFF）* 输出参数：无* 返回值： 无* 例如： m_cap. vSetWaterPrintFontColor (0x0000FF);//红色

3.3.20. 设置水印位置

/*************************************************************************/void vSetWaterPrintPos(short x, short y)/*************************************************************************/* 函数名称：vSetWaterPrintPos* 功能描述：设置水印位置* 输入参数：x——设置水印位置 x轴

y——设置水印位置 y轴* 输出参数：无* 返回值： 无* 例如： m_cap. vSetWaterPrintPos (100, 800);

3.3.21. 设置预览

/*************************************************************************/BOOL vSetImageDispFlag(true)/*************************************************************************/* 函数名称：vSetImageDispFlag* 功能描述：设置是否开启预览* 输出参数：无* 返回值： 无* 例如： m_cap. vSetImageDispFlag(true);

3.3.22. 设置去灰底

/*************************************************************************/void vSetRemoveGBFlag(BOOL bFlag);/*************************************************************************/* 函数名称：vSetRemoveGBFlag* 功能描述：设置是否设置去灰底* 输出参数：无

29

福建捷宇电脑科技有限公司

* 返回值： 无* 例如： m_cap. vSetRemoveGBFlag(true);//去灰底

3.3.23. 获取去灰底

/*************************************************************************/BOOL bGetRemoveGBFlag()/*************************************************************************/* 函数名称：bGetRemoveGBFlag* 功能描述：获取是否设置去灰底* 输出参数：无* 返回值： TRUE——成功

FALSE——失败

3.3.24. 开始合成图片

/*************************************************************************/BOOL bSaveMergeStart (LPCTSTR filePath, LPCTSTR fileName,

short fileType, short cols, long colGap, long rowGap )/*************************************************************************/* 函数名称：bSaveMergeStart* 功能描述：开始合成图片* 输入参数：filePath——保存图片的路径

fileName——保存图片的名称（不用包含后缀名）fileType——图片类型cols——横向列数，如横向为 2，则先排完 2张后再折行colGap——横向间隔距离rowGap——纵向间隔距离

* 输出参数：无* 返回值： TRUE——成功

FALSE——失败

3.3.25. 保存需合并图片

/*************************************************************************/BOOL bSaveMergePage ()/*************************************************************************/* 函数名称：bSaveMergePage* 功能描述：保存需合并的单页* 输入参数：filePath——保存图片的路径

30

福建捷宇电脑科技有限公司

* 输出参数：无* 返回值： TRUE——成功

FALSE——失败

3.3.26. 保存合并现有图片

/*************************************************************************/BOOL bSaveMergePageImage(LPCTSTR imagePath)/*************************************************************************/* 函数名称：bSaveMergePageImage* 功能描述：保存合并现有图片* 输入参数：imagePath——合并图片的路径* 输出参数：无* 返回值： TRUE——成功

FALSE——失败

3.3.27. 结束合成图片

/*************************************************************************/BOOL bSaveMergeEnd()/*************************************************************************/* 函数名称：bSaveMergeEnd* 功能描述：结束合成图片* 输入参数：无* 输出参数：无* 返回值： TRUE——成功

FALSE——失败

3.4.视频处理

3.4.1. 开始录屏

/*************************************************************************/BOOL bStartRec (LPCTSTR aviPath)/*************************************************************************/* 函数名称：bStartRec* 功能描述：开始录屏* 输入参数：aviPath——视频文件路径* 输出参数：无* 返回值： TRUE——成功

FALSE——失败

31

福建捷宇电脑科技有限公司

* 例如： m_cap. bStartRec ("D:\\ test.avi");

3.4.2. 停止录屏

/*************************************************************************/BOOL bStopRec ()/*************************************************************************/* 函数名称：bStopRec* 功能描述：停止录屏* 输入参数：无* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bStopRec ();

3.5.文件操作

3.5.1. 创建目录

/*************************************************************************/BOOL bCreateDir (LPCTSTR dirPath)/*************************************************************************/* 函数名称：bCreateDir* 功能描述：创建目录* 输入参数：dirPath——目录的路径* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bCreateDir ("D:\\ imageDir");

3.5.2. 删除文件、目录

/*************************************************************************/BOOL bDeleteFile(LPCTSTR pathName)/*************************************************************************/* 函数名称：bDeleteFile* 功能描述：删除文件或者目录（删除到回收站）* 输入参数：pathName——文件或者目录的路径

32

福建捷宇电脑科技有限公司

* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bDeleteFile ("D:\\ tif.tif");

3.5.3. 永久删除文件、目录

/*************************************************************************/BOOL bDeleteFileForever(LPCTSTR pathName)/*************************************************************************/* 函数名称：bDeleteFileForever* 功能描述：删除文件或者目录（永久性删除）* 输入参数：pathName——文件或者目录的路径* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bDeleteFileForever ("D:\\ tif.tif");

3.5.4. 复制文件、目录

/*************************************************************************/BOOL bCopyFile(LPCTSTR toPath, LPCTSTR fromPath)/*************************************************************************/* 函数名称：bCopyFile* 功能描述：复制文件或者目录* 输入参数：toPath——新的文件或者目录的路径

fromPath——被复制的文件或者目录的路径* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bCopyFile ("D:\\ tif_bak.tif", "D:\\ tif.tif");

3.5.5. 移动文件、目录

/*************************************************************************/BOOL bMoveFile(LPCTSTR toPath, LPCTSTR fromPath)/*************************************************************************/* 函数名称：bMoveFile* 功能描述：移动文件或者目录* 输入参数：toPath——移动后的文件或者目录的路径

33

福建捷宇电脑科技有限公司

fromPath——被移动的文件或者目录的路径* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bMoveFile ("D:\\ tif_bak.tif", "D:\\ tif.tif");

3.5.6. 重命名文件、目录

/*************************************************************************/BOOL bReNameFile(LPCTSTR toPath, LPCTSTR fromPath)/*************************************************************************/* 函数名称：bReNameFile* 功能描述：重命名文件或者目录* 输入参数：toPath——重命名后的文件或者目录的路径

fromPath——重命名前的文件或者目录的路径* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bReNameFile ("D:\\ tif_New.tif", "D:\\ tif.tif");

3.5.7. 显示目录

/*************************************************************************/BOOL bDispPath (LPCTSTR path)/*************************************************************************/* 函数名称：bDispPath* 功能描述：显示目录* 输入参数：path——目录的路径* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bDispPath ("D:\\ ");

3.6.PDF操作

3.6.1. 开始拍 PDF文件

/*************************************************************************/BOOL bSavePDFStart (LPCTSTR filePath, LPCTSTR fileName)

34

福建捷宇电脑科技有限公司

/*************************************************************************/* 函数名称：bSavePDFStart* 功能描述：开始拍 PDF文件* 输入参数：filePath——保存 PDF文件的路径

filename——保存 PDF文件的名称（不用包含后缀名）* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bSavePDFStart ("D:\","PDFfile");

3.6.2. 保存彩色 PDF单页

/*************************************************************************/BOOL bSavePDFColorPage ()/*************************************************************************/* 函数名称：bSavePDFColorPage* 功能描述：保存彩色 PDF单页* 输入参数：无* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bSavePDFColorPage ();

3.6.3. 增加彩色 PDF单页（已有图片）

/*************************************************************************/BOOL bAddPDFColorPage (BSTR imagePath,float displayFactor)/*************************************************************************/* 函数名称：bAddPDFColorPage* 功能描述：增加彩色 PDF单页* 输入参数：imagePath——图片路径

displayFactor——图片在 PDF文件中显示大小比例（200万像素：0.525；300万像素：0.42；500万像素：0.331）

* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bAddPDFColorPage (“d:\\1.jpg”,0.331);

35

福建捷宇电脑科技有限公司

3.6.4. 保存黑白 PDF单页

/*************************************************************************/BOOL bSavePDFBWPage ()/*************************************************************************/* 函数名称：bSavePDFBWPage* 功能描述：保存黑白 PDF单页* 输入参数：无* 输出参数：无* 返回值: TRUE：成功 FALSE：失败* 例如： m_cap. bSavePDFBWPage ();

3.6.5. 增加黑白 PDF单页（已有图片）

/*************************************************************************/BOOL bAddPDFBWPage (BSTR imagePath,float displayFactor)/*************************************************************************/* 函数名称：bAddPDFBWPage* 功能描述：增加彩色 PDF单页* 输入参数：imagePath——图片路径

displayFactor——图片在 PDF文件中显示大小比例（200万像素：0.525；300万像素：0.42；500万像素：0.331）

* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bAddPDFBWPage (“d:\\1.jpg”,0.331);

3.6.6. 结束保存 PDF文件

/*************************************************************************/BOOL bSavePDFEnd ()/*************************************************************************/* 函数名称：bSavePDFEnd* 功能描述：结束保存 PDF文件* 输入参数：无* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bSavePDFEnd ();

36

福建捷宇电脑科技有限公司

3.7.打印操作

3.7.1. 打印图片

/*************************************************************************/BOOL bPrintImage(short pixelType, LPCTSTR imagePath, short imageType)/*************************************************************************/* 函数名称：bPrintImage* 功能描述：1:1打印图像* 输入参数：* pixelType —— 像素类型（1－200W，2－300W，3－500W）* imagePath —— 图像路径（完整路径）* imageType —— 图像类型（1－jpg，2－tif）* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bPrintImage(1,”D:\\test.jpg”,1);

3.7.2. 直接打印

/*************************************************************************/BOOL bPrint()/*************************************************************************/* 函数名称：bPrint* 功能描述：1:1打印* 输入参数：无* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bPrint();

3.8.上传操作

3.8.1. HTTP上传文件

/*************************************************************************/BOOL bUpLoadImage(LPCTSTR fileName, LPCTSTR serverName,

short usPort, LPCTSTR objectName)/*************************************************************************/

37

福建捷宇电脑科技有限公司

* 函数名称：bUpLoadImage* 功能描述：上传指定图片到服务器* 输入参数：fileName——上传图片的完整路径（多文件上传时，用“|”隔开）

serverName——服务器地址（IP、域名）usPort——端口objectName——处理图片上传的服务器对象

（文件请求字段名称：trackdata）* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如：

单文件上传：m_cap. bUpLoadImage ("D:\\JPG.JPG", "127.0.0.1",8080, "/shop/servlet/uploadServlet");

多文件上传：m_cap. bUpLoadImage ("D:\\JPG.JPG|D:\\JPG1.JPG|D:\\JPG2.JPG","127.0.0.1", 8080, "/shop/servlet/uploadServlet");

3.8.2. HTTP上传文件

/*************************************************************************/BOOL bUpLoadImageEx(LPCTSTR fileName, LPCTSTR serverName, short usPort,

LPCTSTR objectName, BOOL bWaitUI, BOOL bRetUI)/*************************************************************************/* 函数名称：bUpLoadImageEx* 功能描述：上传指定图片到服务器* 输入参数：fileName——上传图片的完整路径（多文件上传时，用“|” 隔开）

serverName——服务器地址（IP、域名）usPort——端口号objectName——处理图片上传的服务器对象

（文件请求字段名称：trackdata）bWaitUI——是否显示等待界面bRetUI——是否显示结果界面

* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如：

单文件上传：m_cap. bUpLoadImage ("D:\\JPG.JPG", "127.0.0.1",8080, "/shop/servlet/uploadServlet",true,true);

多文件上传：m_cap. bUpLoadImage ("D:\\JPG.JPG|D:\\JPG1.JPG|D:\\JPG2.JPG","127.0.0.1", 8080, "/shop/servlet/uploadServlet",true,true);

38

福建捷宇电脑科技有限公司

3.8.3. HTTP上传文件（返回服务端内容）

/*************************************************************************/BSTR sUpLoadImageEx2(LPCTSTR fileName, LPCTSTR serverName, short usPort,

LPCTSTR objectName, BOOL bWaitUI, BOOL bRetUI)/*************************************************************************/* 函数名称：sUpLoadImageEx2* 功能描述：上传指定图片到服务器，并返回服务端响应内容* 输入参数：fileName——上传图片的完整路径（多文件上传时，用“|” 隔开）

serverName——服务器地址（IP、域名）usPort——端口号objectName——处理图片上传的服务器对象

（文件请求字段名称：trackdata）bWaitUI——是否显示等待界面bRetUI——是否显示结果界面

* 输出参数：无* 返回值： 服务器响应内容* 例如：

单文件上传：m_cap. sUpLoadImageEx2("D:\\JPG.JPG", "127.0.0.1",8080, "/shop/servlet/uploadServlet",true,true);

多文件上传：m_cap. sUpLoadImageEx2("D:\\JPG.JPG|D:\\JPG1.JPG|D:\\JPG2.JPG","127.0.0.1", 8080, "/shop/servlet/uploadServlet",true,true);

3.8.4. FTP上传文件

/*************************************************************************/short iUploadFileToFtp(LPCTSTR host, LPCTSTR port,

LPCTSTR userName, LPCTSTR password,LPCTSTR filePath, LPCTSTR ftpPath, LPCTSTR fileName)

/*************************************************************************/* 函数名称：iUploadFileToFtp* 功能描述：上传文件到 FTP* 输入参数：host——服务器地址（IP或域名）

port——端口userName——用户名password——密码filePath——文件路径ftpPath——服务器路径fileName——存放服务器的文件名

* 输出参数：无* 返回值： 0——成功

1——失败

39

福建捷宇电脑科技有限公司

* 例如： m_cap. iUploadFileToFtp (“192.169.0.11”,”21”,”name”,”password”,”c:\boot.ini”,”/FTPPath/temp”,”boot.ini”);

3.8.5. FTP上传文件（是否显示提示消息）

/*************************************************************************/short iUploadFileToFtpEx(LPCTSTR host, LPCTSTR port,

LPCTSTR userName, LPCTSTR password,LPCTSTR filePath, LPCTSTR ftpPath,LPCTSTR fileName,BOOL uiFlag)

/*************************************************************************/* 函数名称：iUploadFileToFtpEx* 功能描述：上传文件到 FTP* 输入参数：host——服务器地址（IP或域名）

port——端口userName——用户名password——密码filePath——文件路径ftpPath——服务器路径fileName——存放服务器的文件名uiFlag——是否显示提示消息

* 输出参数：无* 返回值： 0——成功

1——失败* 例如： m_cap. iUploadFileToFtpEx (“192.169.0.11”,”21”,

”name”,”password”,”c:\boot.ini”,”/FTPPath/temp”,”boot.ini”,true);

3.9.条形码/二维码识别

3.9.1. 识别图片中的条形码/二维码

/*************************************************************************/BSTR sGetBarCode (LPCTSTR imagePath)/*************************************************************************/* 函数名称：sGetBarCode* 功能描述：识别图片中的条形码/二维码* 输入参数：imagePath——图片路径* 输出参数：无

40

福建捷宇电脑科技有限公司

* 返回值： 返回图片中的条形码/二维码，无条码信息返回空串。

3.9.2. 在线识别视频中的条形码/二维码

/*************************************************************************/BSTR sGetBarCodeOnline ()/*************************************************************************/* 函数名称：sGetBarCodeOnline* 功能描述：在线识别视频中的条形码/二维码* 输入参数：无* 输出参数：无* 返回值: 返回视频中的条形码/二维码，无条码信息返回空串。*/

3.10. OCR识别

3.10.1. OCR识别（文档）

/*************************************************************************/BOOL bOCRImage (LPCTSTR ImagePathName, short iLanguageType,

short iFileType, LPCTSTR filePathName)/*************************************************************************/* 函数名称：bOCRImage* 功能描述：对 ImagePathName文件进行 OCR识别* 输入参数：ImagePathName——要识别图片的路径(带后缀，区分大小写)

iLanguageType——文字语言（1：英文，2：中文）iFileType——保存文件类型（1：TXT，2：DOC，3：XLS）filePathName——保存文件路径(带后缀)

* 输出参数：无* 返回值： TRUE——成功

FALSE——失败* 例如： m_cap. bOCRImage ("D:\\A4.jpg",2,2,"D:\\A4.doc");

3.10.2. OCR识别（字符串）

/*************************************************************************/BSTR sOCRImageToString (LPCTSTR ImagePathName, short iLanguageType)/*************************************************************************/* 函数名称：sOCRImageToString

41

福建捷宇电脑科技有限公司

* 功能描述：对 ImagePathName文件进行 OCR识别* 输入参数：ImagePathName——要识别图片的路径(带后缀，区分大小写)

iLanguageType——文字语言（1：英文，2：中文）* 输出参数：无* 返回值： 识别后的字符串* 例如： CSring str = m_cap. sOCRImageToString ("D:\\A4.jpg",2);

//返回 OCR后的字符串

• 功能说明

• 适用平台、语言

• 接口说明

• 摄像头控制

• 显示主视频源

• 显示主视频源（窗口句柄）

• 显示主视频源（窗口句柄、可旋转）

• 显示主视频源（可旋转）

• 显示副视频源（可旋转）

• 显示副视频源（窗口句柄、可旋转）

• 暂停视频源

• 停止视频源

• 显示人像合并

• 停止人像合并

• 视频源放大操作

• 视频源缩小操作

• 视频源还原操作

• 参数设置

• 设置视频源参数

• 设置PIN参数

• 设置DPI

• 获取DPI

• 设置当前旋转角度

• 获取当前旋转角度

• 设置二值化参数

• 获取当前二值化参数

• 设置拍照模式

• 设置拍照区域大小

• 设置图片宽高分辨率的缩放率

• 设置图片的压缩率

• 获取图片保存的压缩率

• 设置自动矫正

• 获取自动矫正

• 设置黑边去除

• 获取黑边去除

• 设置视频压缩类型

• 设置主摄像头分辨率

• 设置视频压缩格式

• 设置摄像头分辨率

• 设置曝光相对值

• 设置亮度相对值

• 设置对比度相对值

• A3图片切割2个A4

• 获取设备ID

• 设置裁边模式

• 设置裁边大小

• 获取焦点

• 设置焦点

• 分割多页

• 设置视频显示模式

• 图片处理

• 保存BMP图片

• 保存JPG图片

• 保存PNG图片

• 保存TIF图片

• 保存黑白TIF图片（支持多页）

• 保存彩色TIF图片（支持多页）

• 保存灰度图和TIF图片

• 保存为TIF并进行OCR识别

• 保存灰度图

• 保存灰度图（支持8、24位）

• 保存黑白JPG图片

• 自动扫描

• 自动扫描（返回拍摄张数）

• 获取JPG图像文件的BASE64数据

• 获取指定图像类型文件的BASE64数据

• 图片旋转

• 设置水印参数

• 设置水印字体大小

• 设置水印字体颜色

• 设置水印位置

• 设置预览

• 设置去灰底

• 获取去灰底

• 开始合成图片

• 保存需合并图片

• 保存合并现有图片

• 结束合成图片

• 视频处理

• 开始录屏

• 停止录屏

• 文件操作

• 创建目录

• 删除文件、目录

• 永久删除文件、目录

• 复制文件、目录

• 移动文件、目录

• 重命名文件、目录

• 显示目录

• PDF操作

• 开始拍PDF文件

• 保存彩色PDF单页

• 增加彩色PDF单页（已有图片）

• 保存黑白PDF单页

• 增加黑白PDF单页（已有图片）

• 结束保存PDF文件

• 打印操作

• 打印图片

• 直接打印

• 上传操作

• HTTP上传文件

• HTTP上传文件

• HTTP上传文件（返回服务端内容）

• FTP上传文件

• FTP上传文件（是否显示提示消息）

• 条形码/二维码识别

• 识别图片中的条形码/二维码

• 在线识别视频中的条形码/二维码

• OCR识别

• OCR识别（文档）

• OCR识别（字符串）