CS SDK
| 高拍仪开发接口文档 |
|---|
| V1.0.0.0_20220501 |
# 获取设备相关信息
接口原型：
YF_CAMERA_API bool WINAPI CameraInfo()
函数名：
bool CameraInfo()
函数描述：
获取接入电脑端的高拍仪设备摄像头名称、分辨率等信息，信息写入ini配置文件中，文件保存于dll同目录下device_demo_dir文件夹中
输入参数
- 无
返回值：
- true -- 获取设备信息成功
- false -- 获取设备信息失败
# 初始化高拍仪
接口原型：
YF_CAMERA_API bool WINAPI initCamera(char* CameraName)
函数名：
bool initCamera(char* CameraName);
函数描述：
初始化选择的摄像头
输入参数：
- CameraName -- 摄像头名称
返回值：
- true -- 初始化高拍仪成功
- false -- 初始化高拍仪失败
# 设置高拍仪显示的分辨率
接口原型：
YF_CAMERA_API bool WINAPI setCaptureSize(int width, int height)
函数名：
bool setCaptureSize(int width, int height)
函数描述：
输入选择的摄像头分辨率参数
输入参数：
- width -- 分辨率的宽度值
- Height – 分辨率的高度值
返回值：
- true -- 初始化高拍仪分辨率成功
- false -- 初始化高拍仪分辨率失败
# 设置预览显示的窗口
接口原型：
YF_CAMERA_API bool WINAPI setPrvWnd(HWND previewHwnd)
函数名：
bool setPrvWnd(HWND previewHwnd)
函数描述：
设置高拍仪预览画面显示的窗口
输入参数：
- previewHwnd – 窗口句柄，用于显示预览画面
返回值：
- true – 设置预览窗口成功
- false – 设置预览窗口失败
# 开始预览
接口原型：
YF_CAMERA_API bool WINAPI startPrvWnd(HWND previewHwnd)
函数名称：
bool startPrvWnd (HWND previewHwnd)
函数描述： 打开摄像头，开始拍摄；参数中传入了窗口句柄，调用前无需调用设置窗口句柄函数；
输入参数：
- previewHwnd – 窗口句柄
返回值：
- true -- 预览成功，窗口显示拍摄画面
- false -- 预览失败
# 停止预览
接口原型：
YF_CAMERA_API long WINAPI stopPreview()
函数名称：
long stopPreview()
函数描述：
开始预览后，执行此函数停止预览
输入参数：
- 无
返回值：
- 0 -- 设置成功；
- -1 -- 设置失败
# 继续预览
接口原型：
YF_CAMERA_API long WINAPI runPreview()
函数名称：
long runPreview()
函数描述：
停止预览后，执行此函数继续预览
输入参数：
- 无
返回值：
- 0 -- 设置成功；
- -1 -- 设置失败
# 设置抓拍图像的类型和压缩率
接口原型：
long WINAPI setImageType(int nType,int nQuaNum)
函数名称：
long setImageType(int nType,int nQuaNum)
函数描述：
设置抓拍图片保存的格式类型、以及压缩率（仅JPG格式有效）
输入参数：
- nType -- 图像类型(均为RGB彩色模式)
- 1--JPG
- 2 --BMP
- 3--TIF
- 4--PNG
返回值：
- 0 -- 设置成功；
- -1 -- 设置失败
# 设置图像的DPI
接口原型：
YF_CAMERA_API bool WINAPI setImgDPI(int nResolution)
函数名称：
bool setImgDPI(int nResolution)
函数描述：
设置图像的DPI值，没有设置时，默认为96
输入参数：
- nResolution -- 图像DPI值，支持数值：72、96、200、300
返回值：
- true – 设置DPI成功
- false – 设置失败
# 设置是否裁边
接口原型：
YF_CAMERA_API long WINAPI setCrop(bool bAutoCrop)
函数名称：
long setCrop(bool bAutoCrop)
函数描述：
设置抓拍的图像是否裁剪边缘，没有设置时默认不裁边
输入参数
- bAutoCrop -- true：自动裁边；false:手动裁边
返回值：
- 0 设置成功；
- -1 -- 设置失败
# 设置自动裁边偏移量
接口原型：
YF_CAMERA_API long WINAPI setAutoCropMargin(int nMargin)
函数名称：
long setAutoCropMargin(int nMargin)
函数描述：
设置自动裁边的偏移量，即边界容差,使自动裁边后的图像更准确
输入参数：
- nMargin -- 取值范围 [-100，100]
返回值：
- 0 -- 设置成功；
- -1 -- 设置失败
# 设置手动裁剪
接口原型：
YF_CAMERA_API long WINAPI setHandCropMargin(int width, int height)
函数名称：
long setHandCropMargin(int width, int height)
函数描述：
输入要裁剪的高、宽数值，进行边框裁剪， 参数为0则不裁剪
输入参数：
- width-- 要裁剪的宽度值
- height -- 要裁剪的高度值
返回值：
- 0 -- 设置成功；
- -1 -- 设置失败
# 获取当前图像
接口原型：
YF_CAMERA_API bool WINAPI captureImageMem(captureImageCB function_cb)
函数名称：
bool captureImageMem(captureImageCB function_cb)
函数描述：
抓取当前预览的图像
输入参数：
回调函数
captureImageCB function_cb
返回值：
- true –- 获取图像成功
- false -- 获取图像失败
回调函数：
typedef void (CALLBACK* captureImageCB)(int length, BYTE* ImgData)
回调参数说明：
- Length -- 返回获取图像的大小
- ImgData – 接收获取图像数据
# 无窗口传参模式预览
接口原型：
YF_CAMERA_API bool WINAPI showVido();
函数名称：
bool showVido();
函数描述：
当无窗口参数传递时，可调用此接口获取预览帧
输入参数：
- 无
返回值：
- true –- 获取帧成功
- false -- 获取帧失败
# 顺、逆时针旋转抓拍图像
接口原型：
bool WINAPI rotateImage(int info)
函数名称：
bool rotateImage(int info)
函数描述：
将抓拍的图像进行顺、逆时针旋转后并保存
输入参数：
- info -- 0：不旋转；1：顺时针旋转90°；2：逆时针旋转90°
返回值：
- true –- 设置成功
- false – 设置失败
# 释放打开的摄像头资源
接口原型：
YF_CAMERA_API long WINAPI releaseCamera ()
函数名称：
long releaseCamera ()
函数描述：
释放创建的视频资源
输入参数：
- 无
返回值：
- 0 -- 释放成功
- -1 -- 释放失败