3399 lines
212 KiB
C
3399 lines
212 KiB
C
|
||
#ifndef _MV_CAMERA_CTRL_H_
|
||
#define _MV_CAMERA_CTRL_H_
|
||
|
||
#include "MvErrorDefine.h"
|
||
#include "CameraParams.h"
|
||
|
||
/**
|
||
* @brief 动态库导入导出定义
|
||
* @brief Import and export definition of the dynamic library
|
||
*/
|
||
#ifndef MV_CAMCTRL_API
|
||
|
||
#if (defined (_WIN32) || defined(WIN64))
|
||
#if defined(MV_CAMCTRL_EXPORTS)
|
||
#define MV_CAMCTRL_API __declspec(dllexport)
|
||
#else
|
||
#define MV_CAMCTRL_API __declspec(dllimport)
|
||
#endif
|
||
#else
|
||
#ifndef __stdcall
|
||
#define __stdcall
|
||
#endif
|
||
|
||
#if defined(MV_CAMCTRL_EXPORTS)
|
||
#define MV_CAMCTRL_API __attribute__((visibility("default")))
|
||
#else
|
||
#define MV_CAMCTRL_API
|
||
#endif
|
||
#endif
|
||
|
||
#endif
|
||
|
||
#ifndef IN
|
||
#define IN
|
||
#endif
|
||
|
||
#ifndef OUT
|
||
#define OUT
|
||
#endif
|
||
|
||
#ifdef __cplusplus
|
||
extern "C" {
|
||
#endif
|
||
|
||
/************************************************************************/
|
||
/* 相机的基本指令和操作 */
|
||
/* Camera basic instructions and operations */
|
||
/************************************************************************/
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取SDK版本号
|
||
* @return 始终返回4字节版本号
|
||
| 主 | 次 | 修正 | 测试 |
|
||
| :---: | :---: | :---: | :---: |
|
||
| 8bits | 8bits | 8bits | 8bits |
|
||
* @remarks 比如返回值为0x01000001，即SDK版本号为V1.0.0.1。
|
||
|
||
* @~english
|
||
* @brief Get SDK Version
|
||
* @return Always return 4 Bytes of version number
|
||
| Main | Sub | Rev | Test |
|
||
| :---: | :---: | :---: | :---: |
|
||
| 8bits | 8bits | 8bits | 8bits |
|
||
* @remarks For example, if the return value is 0x01000001, the SDK version is V1.0.0.1.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API unsigned int __stdcall MV_CC_GetSDKVersion();
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取支持的传输层
|
||
* @return 支持的传输层编号
|
||
|
||
* @~english
|
||
* @brief Get supported Transport Layer
|
||
* @return Supported Transport Layer number
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_EnumerateTls();
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 枚举设备
|
||
* @param nTLayerType [IN] 枚举传输层
|
||
* @param pstDevList [OUT] 设备列表
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 设备列表的内存是在SDK内部分配的，多线程调用该接口时会进行设备列表内存的释放和申请.\n
|
||
建议尽量避免多线程枚举操作。
|
||
|
||
* @~english
|
||
* @brief Enumerate Device
|
||
* @param nTLayerType [IN] Enumerate TLs
|
||
* @param pstDevList [OUT] Device List
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks @remarks The memory of the device list is allocated within the SDK. When the interface is invoked by multiple threads, the memory of the device list will be released and applied.\n
|
||
It is recommended to avoid multithreaded enumeration operations as much as possible.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_EnumDevices(IN unsigned int nTLayerType, IN OUT MV_CC_DEVICE_INFO_LIST* pstDevList);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 根据厂商名字枚举设备
|
||
* @param nTLayerType [IN] 枚举传输层
|
||
* @param pstDevList [OUT] 设备列表
|
||
* @param pManufacturerName [IN] 厂商名字
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Enumerate device according to manufacture name
|
||
* @param nTLayerType [IN] Transmission layer of enumeration
|
||
* @param pstDevList [OUT] Device list
|
||
* @param pManufacturerName [IN] Manufacture Name
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_EnumDevicesEx(IN unsigned int nTLayerType, IN OUT MV_CC_DEVICE_INFO_LIST* pstDevList, IN const char* pManufacturerName);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设备是否可达
|
||
* @param pstDevInfo [IN] 设备信息结构体
|
||
* @param nAccessMode [IN] 访问权限
|
||
* @return 可达，返回true；不可达，返回false
|
||
* @remarks 读取设备CCP寄存器的值，判断当前状态是否具有某种访问权限。 \n
|
||
如果设备不支持 #MV_ACCESS_ExclusiveWithSwitch、 #MV_ACCESS_ControlWithSwitch、 #MV_ACCESS_ControlSwitchEnableWithKey这三种模式，接口返回false。目前设备不支持这3种抢占模式，国际上主流的厂商的相机也都暂不支持这3种模式。 \n
|
||
该接口不支持CameraLink设备。
|
||
|
||
* @~english
|
||
* @brief Is the device accessible
|
||
* @param pstDevInfo [IN] Device Information Structure
|
||
* @param nAccessMode [IN] Access Right
|
||
* @return Access, return true. Not access, return false
|
||
@remarks Read device CCP register value and determine current access permission.\n
|
||
Return false if the device does not support the modes #MV_ACCESS_ExclusiveWithSwitch, #MV_ACCESS_ControlWithSwitch, #MV_ACCESS_ControlSwitchEnableWithKey. Currently the device does not support the 3 preemption modes, neither do the devices from other mainstream manufacturers. \n
|
||
This API is not supported by CameraLink device.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API bool __stdcall MV_CC_IsDeviceAccessible(IN MV_CC_DEVICE_INFO* pstDevInfo, IN unsigned int nAccessMode);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置SDK日志路径（如果日志服务MvLogServer已启用，则该接口无效，默认日志服务为开启状态）
|
||
* @param pSDKLogPath [IN] SDK日志路径
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 设置路径之后，可以指定路径存放日志。\n
|
||
v2.4.1版本新增日志服务，开启服务之后该接口无效。
|
||
|
||
* @~english
|
||
* @brief Set SDK log path
|
||
* @param pSDKLogPath [IN] SDK log path
|
||
* @return Access, return true. Not access, return false
|
||
* @remarks For version V2.4.1, added log service, this API is invalid when the service is enabled.And The logging service is enabled by default\n
|
||
This API is used to set the log file storing path.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetSDKLogPath(IN const char * pSDKLogPath);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 创建设备句柄
|
||
* @param handle [OUT] 设备句柄
|
||
* @param pstDevInfo [IN] 设备信息结构体
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 根据输入的设备信息，创建库内部必须的资源和初始化内部模块。通过该接口创建句柄，调用SDK接口，会默认生成SDK日志文件，保存在当前可执行程序路径下的MvSdkLog文件夹，如果不需要生成日志文件，可以通过MV_CC_CreateHandleWithoutLog创建句柄。
|
||
|
||
* @~english
|
||
* @brief Create Device Handle
|
||
* @param handle [OUT] Device handle
|
||
* @param pstDevInfo [IN] Device Information Structure
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Create required resources within library and initialize internal module according to input device information. Create handle and call SDK interface through this interface, and SDK log file will be created by default. Creating handle through #MV_CC_CreateHandleWithoutLog will not generate log files.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_CreateHandle(OUT void ** handle, IN const MV_CC_DEVICE_INFO* pstDevInfo);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 创建设备句柄，不生成日志
|
||
* @param handle [OUT] 设备句柄
|
||
* @param pstDevInfo [IN] 设备信息结构体
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 根据输入的设备信息，创建库内部必须的资源和初始化内部模块。通过该接口创建句柄，调用SDK接口，不会默认生成SDK日志文件，如果需要生成日志文件可以通过MV_CC_CreateHandle创建句柄，日志文件自动生成，保存在当前可执行程序路径下的MvSdkLog文件夹。
|
||
|
||
* @~english
|
||
* @brief Create Device Handle without log
|
||
* @param handle [OUT] Device handle
|
||
* @param pstDevInfo [IN] Device Information Structure
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Create required resources within library and initialize internal module according to input device information. Create handle and call SDK interface through this interface, and SDK log file will not be created. To create logs, create handle through MV_CC_CreateHandle, and log files will be automatically generated.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_CreateHandleWithoutLog(OUT void ** handle, IN const MV_CC_DEVICE_INFO* pstDevInfo);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 销毁设备句柄
|
||
* @param handle [IN] 设备句柄
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
|
||
* @~english
|
||
* @brief Destroy Device Handle
|
||
* @param handle [IN] Device handle
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_DestroyHandle(IN void * handle);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 打开设备
|
||
* @param handle [IN] 设备句柄
|
||
* @param nAccessMode [IN] 访问权限
|
||
* @param nSwitchoverKey [IN] 切换访问权限时的密钥
|
||
* @return 成功，返回#MV_OK ；错误，返回错误码
|
||
* @remarks 根据设置的设备参数，找到对应的设备，连接设备。\n
|
||
调用接口时可不传入nAccessMode和nSwitchoverKey，此时默认设备访问模式为独占权限。目前设备暂不支持#MV_ACCESS_ExclusiveWithSwitch、 #MV_ACCESS_ControlWithSwitch、MV_ACCESS_ControlSwitchEnable、MV_ACCESS_ControlSwitchEnableWithKey这四种抢占模式。\n
|
||
对于U3V设备，nAccessMode、nSwitchoverKey这两个参数无效。
|
||
|
||
* @~english
|
||
* @brief Open Device
|
||
* @param handle [IN] Device handle
|
||
* @param nAccessMode [IN] Access Right
|
||
* @param nSwitchoverKey [IN] Switch key of access right
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Find specific device and connect according to set device parameters. \n
|
||
When calling the interface, the input of nAccessMode and nSwitchoverKey is optional, and the device access mode is exclusive. Currently the device does not support the following preemption modes: MV_ACCESS_ExclusiveWithSwitch, MV_ACCESS_ControlWithSwitch, MV_ACCESS_ControlSwitchEnableWithKey.\n
|
||
For USB3Vision device, nAccessMode, nSwitchoverKey are invalid.
|
||
************************************************************************/
|
||
#ifndef __cplusplus
|
||
MV_CAMCTRL_API int __stdcall MV_CC_OpenDevice(IN void* handle, IN unsigned int nAccessMode, IN unsigned short nSwitchoverKey);
|
||
#else
|
||
MV_CAMCTRL_API int __stdcall MV_CC_OpenDevice(IN void* handle, IN unsigned int nAccessMode = MV_ACCESS_Exclusive, IN unsigned short nSwitchoverKey = 0);
|
||
#endif
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 关闭相机
|
||
* @param handle [IN] 设备句柄
|
||
* @return 成功，返回#MV_OK ；错误，返回错误码
|
||
* @remarks 通过MV_CC_OpenDevice连接设备后，可以通过该接口断开设备连接，释放资源
|
||
|
||
* @~english
|
||
* @brief Close Device
|
||
* @param handle [IN] Device handle
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks After connecting to device through MV_CC_OpenDevice, use this interface to disconnect and release resources.
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_CloseDevice(IN void* handle);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 判断相机是否处于连接状态
|
||
* @param handle [IN] 设备句柄
|
||
* @return 设备处于连接状态，返回true；没连接或失去连接，返回false
|
||
|
||
* @~english
|
||
* @brief Is The Device Connected
|
||
* @param handle [IN] Device handle
|
||
* @return Connected, return true. Not Connected or DIsconnected, return false
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API bool __stdcall MV_CC_IsDeviceConnected(IN void* handle);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 注册图像数据回调
|
||
* @param handle [IN] 设备句柄
|
||
* @param cbOutput [IN] 回调函数指针
|
||
* @param pUser [IN] 用户自定义变量
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 通过该接口可以设置图像数据回调函数，在MV_CC_CreateHandle之后即可调用。 \n
|
||
图像数据采集有两种方式，两种方式不能复用：
|
||
- 方式一：调用MV_CC_RegisterImageCallBackEx设置图像数据回调函数，然后调用MV_CC_StartGrabbing开始采集，采集的图像数据在设置的回调函数中返回。
|
||
- 方式二：调用MV_CC_StartGrabbing开始采集，然后在应用层循环调用MV_CC_GetOneFrameTimeout获取指定像素格式的帧数据，获取帧数据时上层应用程序需要根据帧率控制好调用该接口的频率。
|
||
该接口仅在windows版本和Linux版本下支持。\n
|
||
该接口不支持CameraLink设备。
|
||
|
||
* @~english
|
||
* @brief Register the image callback function
|
||
* @param handle [IN] Device handle
|
||
* @param cbOutput [IN] Callback function pointer
|
||
* @param pUser [IN] User defined variable
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks After MV_CC_CreateHandle, call this interface to set image data callback function.\n
|
||
There are two available image data acquisition modes, and cannot be used together:
|
||
- Mode 1: Call MV_CC_RegisterImageCallBack to set image data callback function, and then call MV_CC_StartGrabbing to start acquiring. The acquired image data will return in the set callback function.
|
||
- Mode 2: Call MV_CC_StartGrabbing to start acquiring, and then call MV_CC_GetOneFrameTimeout repeatedly in application layer to get frame data of specified pixel format. When getting frame data, the frequency of calling this interface should be controlled by upper layer application according to frame rate.
|
||
This API is not supported by CameraLink device.
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_RegisterImageCallBackEx(void* handle,
|
||
void(__stdcall* cbOutput)(unsigned char * pData, MV_FRAME_OUT_INFO_EX* pFrameInfo, void* pUser),
|
||
void* pUser);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 注册图像数据回调，RGB
|
||
* @param handle [IN] 设备句柄
|
||
* @param cbOutput [IN] 回调函数指针
|
||
* @param pUser [IN] 用户自定义变量
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 通过该接口可以设置图像数据回调函数，在MV_CC_CreateHandle之后即可调用。 \n
|
||
图像数据采集有两种方式，两种方式不能复用：
|
||
- 方式一：调用MV_CC_RegisterImageCallBackForRGB设置RGB24格式图像数据回调函数，然后调用MV_CC_StartGrabbing开始采集，采集的图像数据在设置的回调函数中返回。
|
||
- 方式二：调用MV_CC_StartGrabbing开始采集，然后在应用层循环调用MV_CC_GetImageForRGB获取RGB24格式的帧数据，获取帧数据时上层应用程序需要根据帧率控制好调用该接口的频率。\n\n
|
||
该接口仅在windows版本和Linux版本下支持。 \n
|
||
该接口不支持CameraLink设备。
|
||
|
||
* @~english
|
||
* @brief register image data callback, RGB
|
||
* @param handle [IN] Device handle
|
||
* @param cbOutput [IN] Callback function pointer
|
||
* @param pUser [IN] User defined variable
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Before calling this API to set image data callback function, you should call this API MV_CC_CreateHandle. \n
|
||
There are two image acquisition modes, the two modes cannot be reused:
|
||
- Mode 1: Call #MV_CC_RegisterImageCallBackForRGB to set RGB24 format image data callback function,
|
||
and then call #MV_CC_StartGrabbing to start acquisition,
|
||
the collected image data will be returned in the configured callback function.
|
||
- Mode 2: Call MV_CC_StartGrabbing to start acquisition, and the call MV_CC_GetImageForRGB
|
||
repeatedly in application layer to get frame data with RGB24 format.
|
||
When getting frame data, the upper application program should control the frequency
|
||
of calling this API according to frame rate. \n\n
|
||
This API is not supported by CameraLink device.
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_RegisterImageCallBackForRGB(void* handle,
|
||
void(__stdcall* cbOutput)(unsigned char * pData, MV_FRAME_OUT_INFO_EX* pFrameInfo, void* pUser),
|
||
void* pUser);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 注册图像数据回调，BGR
|
||
* @param handle [IN] 设备句柄
|
||
* @param cbOutput [IN] 回调函数指针
|
||
* @param pUser [IN] 用户自定义变量
|
||
* @return 成功，返回 #MV_OK ；错误，返回错误码
|
||
* @remarks 通过该接口可以设置图像数据回调函数，在MV_CC_CreateHandle之后即可调用。\n
|
||
图像数据采集有两种方式，两种方式不能复用：\n
|
||
- 方式一：调用 #MV_CC_RegisterImageCallBackForBGR 设置 #BGR24 图像数据回调函数，然后调用 #MV_CC_StartGrabbing 开始采集，采集的图像数据在设置的回调函数中返回。
|
||
- 方式二：调用 #MV_CC_StartGrabbing 开始采集，然后在应用层循环调用 #MV_CC_GetImageForBGR 获取 #BGR24 格式的帧数据，获取帧数据时上层应用程序需要根据帧率控制好调用该接口的频率。 \n\n
|
||
该接口仅在windows版本和Linux版本下支持。 \n
|
||
该接口不支持CameraLink设备。
|
||
|
||
* @~english
|
||
* @brief register image data callback, BGR
|
||
* @param handle [IN] Device handle
|
||
* @param cbOutput [IN] Callback function pointer
|
||
* @param pUser [IN] User defined variable
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Before calling this API to set image data callback function, you should call this API MV_CC_CreateHandle. \n
|
||
There are two image acquisition modes, the two modes cannot be reused: \n
|
||
- Mode 1: Call MV_CC_RegisterImageCallBackForBGR to set RGB24 format image data callback function, and then call MV_CC_StartGrabbing to start acquisition, the collected image data will be returned in the configured callback function.\n
|
||
- Mode 2: Call MV_CC_StartGrabbing to start acquisition, and the call MV_CC_GetImageForBGR repeatedly in application layer to get frame data with BGR24 format. When getting frame data, the upper application program should control the frequency of calling this API according to frame rate.\n
|
||
This API is not supported by CameraLink device.
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_RegisterImageCallBackForBGR(void* handle,
|
||
void(__stdcall* cbOutput)(unsigned char * pData, MV_FRAME_OUT_INFO_EX* pFrameInfo, void* pUser),
|
||
void* pUser);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 开始取流
|
||
* @param handle [IN] 设备句柄
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 该接口不支持CameraLink设备。
|
||
|
||
* @~english
|
||
* @brief Start Grabbing
|
||
* @param handle [IN] Device handle
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks This API is not supported by CameraLink device.
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_StartGrabbing(IN void* handle);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 停止取流
|
||
* @param handle [IN] 设备句柄
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 该接口不支持CameraLink设备。
|
||
|
||
* @~english
|
||
* @brief Stop Grabbing
|
||
* @param handle [IN] Device handle
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks This API is not supported by CameraLink device.
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_StopGrabbing(IN void* handle);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取一帧RGB数据，此函数为查询式获取，每次调用查询内部
|
||
缓存有无数据，有数据则获取数据，无数据返回错误码
|
||
* @param handle [IN] 设备句柄
|
||
* @param pData [OUT] 图像数据接收指针
|
||
* @param nDataSize [IN] 接收缓存大小
|
||
* @param pFrameInfo [OUT] 图像信息结构体
|
||
* @param nMsec [IN] 等待超时时间
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 每次调用该接口，将查询内部缓存是否有数据，如果有数据则转换成RGB24格式返回，如果没有数据则返回错误码。因为图像转换成RGB24格式有耗时，所以当数据帧率过高时该接口可能会导致丢帧。\n
|
||
调用该接口获取图像数据帧之前需要先调用MV_CC_StartGrabbing启动图像采集。该接口为主动式获取帧数据，上层应用程序需要根据帧率，控制好调用该接口的频率。 \n
|
||
该接口不支持CameraLink设备。 \n
|
||
该接口仅在windows版本和Linux版本下支持。
|
||
|
||
* @~english
|
||
* @brief Get one frame of RGB data, this function is using query to get data
|
||
query whether the internal cache has data, get data if there has, return error code if no data
|
||
* @param handle [IN] Device handle
|
||
* @param pData [OUT] Image data receiving buffer
|
||
* @param nDataSize [IN] Buffer size
|
||
* @param pFrameInfo [OUT] Image information structure
|
||
* @param nMsec [IN] Waiting timeout
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Before calling this API to set image data callback function, you should call this API MV_CC_CreateHandle. \n
|
||
There are two image acquisition modes, the two modes cannot be reused: \n
|
||
- Mode 1: Call MV_CC_RegisterImageCallBackForBGR to set RGB24 format image data callback function, and then call MV_CC_StartGrabbing to start acquisition, the collected image data will be returned in the configured callback function.\n
|
||
- Mode 2: Call MV_CC_StartGrabbing to start acquisition, and the call MV_CC_GetImageForBGR repeatedly in application layer to get frame data with BGR24 format. When getting frame data, the upper application program should control the frequency of calling this API according to frame rate. \n
|
||
This API is not supported by CameraLink device.
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetImageForRGB(IN void* handle, IN OUT unsigned char * pData , IN unsigned int nDataSize, IN OUT MV_FRAME_OUT_INFO_EX* pFrameInfo, int nMsec);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取一帧BGR数据，此函数为查询式获取，每次调用查询内部
|
||
缓存有无数据，有数据则获取数据，无数据返回错误码
|
||
* @param handle [IN] 设备句柄
|
||
* @param pData [OUT] 图像数据接收指针
|
||
* @param nDataSize [IN] 接收缓存大小
|
||
* @param pFrameInfo [OUT] 图像信息结构体
|
||
* @param nMsec [IN] 等待超时时间
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 每次调用该接口，将查询内部缓存是否有数据，如果有数据则转换成BGR24格式返回，如果没有数据则返回错误码。因为图像转换成BGR24格式有耗时，所以当数据帧率过高时该接口可能会导致丢帧。 \n
|
||
调用该接口获取图像数据帧之前需要先调用MV_CC_StartGrabbing启动图像采集。该接口为主动式获取帧数据，上层应用程序需要根据帧率，控制好调用该接口的频率。\n
|
||
该接口不支持CameraLink设备。\n
|
||
该接口仅在windows版本和Linux版本下支持。
|
||
|
||
|
||
* @~english
|
||
* @brief Get one frame of BGR data, this function is using query to get data
|
||
query whether the internal cache has data, get data if there has, return error code if no data
|
||
* @param handle [IN] Device handle
|
||
* @param pData [OUT] Image data receiving buffer
|
||
* @param nDataSize [IN] Buffer size
|
||
* @param pFrameInfo [OUT] Image information structure
|
||
* @param nMsec [IN] Waiting timeout
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Before calling this API to set image data callback function, you should call this API MV_CC_CreateHandle. \n
|
||
There are two image acquisition modes, the two modes cannot be reused: \n
|
||
- Mode 1: Call MV_CC_RegisterImageCallBackForBGR to set RGB24 format image data callback function, and then call MV_CC_StartGrabbing to start acquisition, the collected image data will be returned in the configured callback function.\n
|
||
- Mode 2: Call MV_CC_StartGrabbing to start acquisition, and the call MV_CC_GetImageForBGR repeatedly in application layer to get frame data with BGR24 format. When getting frame data, the upper application program should control the frequency of calling this API according to frame rate. \n
|
||
This API is not supported by CameraLink device.
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetImageForBGR(IN void* handle, IN OUT unsigned char * pData , IN unsigned int nDataSize, IN OUT MV_FRAME_OUT_INFO_EX* pFrameInfo, int nMsec);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 使用内部缓存获取一帧图片（与MV_CC_Display不能同时使用）
|
||
* @param handle [IN] 设备句柄
|
||
* @param pFrame [OUT] 图像数据和图像信息
|
||
* @param nMsec [IN] 等待超时时间，输入INFINITE时表示无限等待，直到收到一帧数据或者停止取流
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 调用该接口获取图像数据帧之前需要先调用MV_CC_StartGrabbing启动图像采集。该接口为主动式获取帧数据，上层应用程序需要根据帧率，控制好调用该接口的频率。该接口支持设置超时时间，SDK内部等待直到有数据时返回，可以增加取流平稳性，适合用于对平稳性要求较高的场合。 \n
|
||
该接口与MV_CC_FreeImageBuffer配套使用，当处理完取到的数据后，需要用MV_CC_FreeImageBuffer接口将pFrame内的数据指针权限进行释放。 \n
|
||
该接口与MV_CC_GetOneFrameTimeout相比，有着更高的效率。且其取流缓存的分配是由sdk内部自动分配的，而MV_CC_GetOneFrameTimeout接口是需要客户自行分配。\n
|
||
该接口在调用MV_CC_Display后无法取流。 \n
|
||
该接口对于U3V、GIGE设备均可支持。 \n
|
||
该接口不支持CameraLink设备。
|
||
|
||
* @~english
|
||
* @brief Get a frame of an image using an internal cache
|
||
* @param handle [IN] Device handle
|
||
* @param pFrame [OUT] Image data and image information
|
||
* @param nMsec [IN] Waiting timeout
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Before calling this API to get image data frame, you should call MV_CC_StartGrabbing to start image acquisition. This API can get frame data actively, the upper layer program should control the frequency of calling this API according to the frame rate. This API supports setting timeout, and SDK will wait to return until data appears. This function will increase the streaming stability, which can be used in the situation with high stability requirement. \n
|
||
This API and MV_CC_FreeImageBuffer should be called in pairs, after processing the acquired data, you should call MV_CC_FreeImageBuffer to release the data pointer permission of pFrame. \n
|
||
This interface is more efficient than MV_CC_GetOneFrameTimeout. The allocation of the stream cache is automatically allocated within the SDK.The MV_CC_GetOneFrameTimeout interface needs to be allocated by customers themselves. \n
|
||
This API cannot be called to stream after calling MV_CC_Display. \n
|
||
This API is not supported by CameraLink device. \n
|
||
This API is supported by both USB3 vision camera and GigE camera. \n
|
||
**********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetImageBuffer(IN void* handle, OUT MV_FRAME_OUT* pFrame, IN unsigned int nMsec);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 释放图像缓存(此接口用于释放不再使用的图像缓存，与MV_CC_GetImageBuffer配套使用)
|
||
* @param handle [IN] 设备句柄
|
||
* @param pFrame [IN] 图像数据和图像数据
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 该接口与MV_CC_GetImageBuffer配套使用，使用MV_CC_GetImageBuffer接口取到的图像数据pFrame，需要用 #MV_CC_FreeImageBuffer 接口进行权限释放。 \n
|
||
该接口对于取流效率高于GetOneFrameTimeout接口，且GetImageBuffer在不进行Free的情况下，最大支持输出的节点数与 #MV_CC_SetImageNodeNum 接口所设置的节点数相等，默认节点数是1。\n
|
||
该接口对于U3V、GIGE设备均可支持。 \n
|
||
该接口不支持CameraLink设备。
|
||
|
||
* @~english
|
||
* @brief Free image buffer(this interface can free image buffer, used with MV_CC_GetImageBuffer)
|
||
* @param handle [IN] Device handle
|
||
* @param pFrame [IN] Image data and image information
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks This API and MV_CC_GetImageBuffer should be called in pairs, before calling MV_CC_GetImageBuffer to get image data pFrame, you should call #MV_CC_FreeImageBuffer to release the permission. \n
|
||
Compared with API MV_CC_GetOneFrameTimeout, this API has higher efficiency of image acquisition. The max. number of nodes can be outputted is same as the "nNum" of API #MV_CC_SetImageNodeNum, default value is 1. \n
|
||
This API is not supported by CameraLink device. \n
|
||
This API is supported by both USB3 vision camera and GigE camera.
|
||
**********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_FreeImageBuffer(IN void* handle, IN MV_FRAME_OUT* pFrame);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 采用超时机制获取一帧图片，SDK内部等待直到有数据时返回
|
||
* @param handle [IN] 设备句柄
|
||
* @param pData [OUT] 图像数据接收指针
|
||
* @param nDataSize [IN] 接收缓存大小
|
||
* @param pFrameInfo [OUT] 图像信息结构体
|
||
* @param nMsec [IN] 等待超时时间
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 调用该接口获取图像数据帧之前需要先调用MV_CC_StartGrabbing启动图像采集。该接口为主动式获取帧数据，上层应用程序需要根据帧率，控制好调用该接口的频率。该接口支持设置超时时间，SDK内部等待直到有数据时返回，可以增加取流平稳性，适合用于对平稳性要求较高的场合。\n
|
||
该接口对于U3V、GIGE设备均可支持。\n
|
||
该接口不支持CameraLink设备。
|
||
|
||
* @~english
|
||
* @brief Timeout mechanism is used to get image, and the SDK waits inside until the data is returned
|
||
* @param handle [IN] Device handle
|
||
* @param pData [OUT] Image data receiving buffer
|
||
* @param nDataSize [IN] Buffer size
|
||
* @param pFrameInfo [OUT] Image information structure
|
||
* @param nMsec [IN] Waiting timeout
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Before calling this API to get image data frame, call MV_CC_StartGrabbing to start image acquisition. This API can get frame data actively, the upper layer program should control the frequency of calling this API according to the frame rate. This API supports setting timeout, SDK will wait to return until data appears. This function will increase the streaming stability, which can be used in the situation with high stability requirement. \n
|
||
Both the USB3Vision and GIGE camera can support this API. \n
|
||
This API is not supported by CameraLink device.
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetOneFrameTimeout(IN void* handle, IN OUT unsigned char * pData , IN unsigned int nDataSize, IN OUT MV_FRAME_OUT_INFO_EX* pFrameInfo, unsigned int nMsec);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 清除取流数据缓存
|
||
* @param handle [IN] 设备句柄
|
||
* @return 成功，返回MV_OK；错误，返回错误码
|
||
* @remarks 该接口允许用户在不停止取流的时候，就能清除缓存中不需要的图像。\n
|
||
该接口在连续模式切触发模式后，可以清除历史数据。
|
||
|
||
* @~english
|
||
* @brief if Image buffers has retrieved the data，Clear them
|
||
* @param handle [IN] Device handle
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks This interface allows user to clear the unnecessary images from the buffer memory without stopping acquisition. \n
|
||
This interface allows user to clear previous data after switching from continuous mode to trigger mode.
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_ClearImageBuffer(IN void* handle);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 显示图像，注册显示窗口，内部自动显示（与MV_CC_GetImageBuffer不能同时使用）
|
||
* @param handle [IN] 句柄
|
||
* @param hWnd [IN] 显示窗口句柄
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
|
||
* @~english
|
||
* @brief Display one frame image, register display window, automatic display internally
|
||
* @param handle [IN] Handle
|
||
* @param hWnd [IN] Display Window Handle
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_Display(IN void* handle, void* hWnd);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 显示一帧图像
|
||
* @param handle [IN] 设备句柄
|
||
* @param pDisplayInfo [IN] 图像信息
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 该接口对于U3V、GIGE设备均可支持。\n
|
||
该接口不支持CameraLink设备。
|
||
|
||
* @~english
|
||
* @brief Display one frame image
|
||
* @param handle [IN] Device handle
|
||
* @param pDisplayInfo [IN] Frame Info
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks This API is valid for USB3Vision camera and GIGE camera. \n
|
||
This API is not supported by CameraLink device.
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_DisplayOneFrame(IN void* handle, IN MV_DISPLAY_FRAME_INFO* pDisplayInfo);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置SDK内部图像缓存节点个数，大于等于1，在抓图前调用
|
||
* @param handle [IN] 设备句柄
|
||
* @param nNum [IN] 缓存节点个数，范围[1,30]，默认为1
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 调用该接口可以设置SDK内部图像缓存节点个数，在调用MV_CC_StartGrabbing开始抓图前调用。\n
|
||
增加图像缓存节点个数会增加SDK使用的内存，但是可以有效避免某些性能差的ARM板出现的跳帧现象。\n
|
||
该接口不支持CameraLink设备。
|
||
|
||
* @~english
|
||
* @brief Set the number of the internal image cache nodes in SDK, Greater than or equal to 1, to be called before the capture
|
||
* @param handle [IN] Device handle
|
||
* @param nNum [IN] Image Node Number, range[1,30], default 1
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Call this interface to set the number of SDK internal image buffer nodes.
|
||
The interface should be called before calling MV_CC_StartGrabbing for capturing. \n
|
||
Increasing the number of image cache nodes will increase the memory used by the SDK,
|
||
but it can effectively avoid frame skipping on some ARM boards with poor performance. \n
|
||
This API is not supported by CameraLink device.
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetImageNodeNum(IN void* handle, unsigned int nNum);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取设备信息，取流之前调用
|
||
* @param handle [IN] 设备句柄
|
||
* @param pstDevInfo [IN][OUT] 返回给调用者有关相机设备信息结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 支持用户在打开设备后获取设备信息。\n
|
||
若该设备是GigE相机，则调用该接口存在阻塞风险，因此不建议在取流过程中调用该接口。
|
||
|
||
* @~english
|
||
* @brief Get device information
|
||
* @param handle [IN] Device handle
|
||
* @param pstDevInfo [IN][OUT] Structure pointer of device information
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks The API support users to access device information after opening the device. \n
|
||
If the device is a GigE camera, there is a blocking risk in calling the interface, so it is not recommended to call the interface during the fetching process.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetDeviceInfo(IN void * handle, IN OUT MV_CC_DEVICE_INFO* pstDevInfo);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取各种类型的信息
|
||
* @param handle [IN] 设备句柄
|
||
* @param pstInfo [IN][OUT] 返回给调用者有关相机各种类型的信息结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 接口里面输入需要获取的信息类型（指定MV_ALL_MATCH_INFO结构体中的nType类型），获取对应的信息（在MV_ALL_MATCH_INFO结构体中pInfo里返回）。 \n
|
||
该接口的调用前置条件取决于所获取的信息类型，获取GigE设备的MV_MATCH_TYPE_NET_DETECT信息需在开启抓图之后调用，获取U3V设备的MV_MATCH_TYPE_USB_DETECT信息需在打开设备之后调用。 \n
|
||
该接口不支持CameraLink设备。
|
||
|
||
* @~english
|
||
* @brief Get various type of information
|
||
* @param handle [IN] Device handle
|
||
* @param pstInfo [IN][OUT] Structure pointer of various type of information
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Input required information type (specify nType in structure MV_ALL_MATCH_INFO) in the interface and get corresponding information (return in pInfo of structure MV_ALL_MATCH_INFO). \n
|
||
The calling precondition of this interface is determined by obtained information type. Call after enabling capture to get MV_MATCH_TYPE_NET_DETECT information of GigE device, and call after starting device to get MV_MATCH_TYPE_USB_DETECT information of USB3Vision device. \n
|
||
This API is not supported by CameraLink device.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetAllMatchInfo(IN void* handle, IN OUT MV_ALL_MATCH_INFO* pstInfo);
|
||
|
||
/************************************************************************/
|
||
/* 设置和获取相机参数的万能接口 */
|
||
/* General interface for getting and setting camera parameters */
|
||
/************************************************************************/
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取Integer属性值
|
||
* @param handle [IN] 设备句柄
|
||
* @param strKey [IN] 属性键值，如获取宽度信息则为"Width"
|
||
* @param pIntValue [IN][OUT] 返回给调用者有关相机属性结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 连接设备之后调用该接口可以获取int类型的指定节点的值。strKey取值可以参考XML节点参数类型列表，
|
||
* 表格里面数据类型为“IInteger”的节点值都可以通过该接口获取，strKey参数取值对应列表里面的“名称”一列。
|
||
|
||
* @~english
|
||
* @brief Get Integer value
|
||
* @param handle [IN] Device handle
|
||
* @param strKey [IN] Key value, for example, using "Width" to get width
|
||
* @param pIntValue [IN][OUT] Structure pointer of camera features
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks You can call this API to get the value of camera node with integer type after connecting the device.
|
||
* For strKey value, refer to MvCameraNode. All the node values of "IInteger" in the list
|
||
* can be obtained via this API. strKey corresponds to the Name column.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetIntValue(IN void* handle,IN const char* strKey,OUT MVCC_INTVALUE *pIntValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取Integer属性值
|
||
* @param handle [IN] 设备句柄
|
||
* @param strKey [IN] 属性键值，如获取宽度信息则为"Width"
|
||
* @param pIntValue [IN][OUT] 返回给调用者有关相机属性结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 连接设备之后调用该接口可以获取int类型的指定节点的值。strKey取值可以参考XML节点参数类型列表，
|
||
* 表格里面数据类型为“IInteger”的节点值都可以通过该接口获取，strKey参数取值对应列表里面的“名称”一列。
|
||
|
||
* @~english
|
||
* @brief Get Integer value
|
||
* @param handle [IN] Device handle
|
||
* @param strKey [IN] Key value, for example, using "Width" to get width
|
||
* @param pIntValue [IN][OUT] Structure pointer of camera features
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks You can call this API to get the value of camera node with integer type after connecting the device.
|
||
* For strKey value, refer to MvCameraNode. All the node values of "IInteger" in the list
|
||
* can be obtained via this API. strKey corresponds to the Name column.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetIntValueEx(IN void* handle,IN const char* strKey,OUT MVCC_INTVALUE_EX *pIntValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置Integer型属性值
|
||
* @param handle [IN] 设备句柄
|
||
* @param strKey [IN] 属性键值，如获取宽度信息则为"Width"
|
||
* @param nValue [IN] 想要设置的相机的属性值
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 连接设备之后调用该接口可以设置int类型的指定节点的值。strKey取值可以参考XML节点参数类型列表，表格里面数据类型为“IInteger”的节点值都可以通过该接口设置，strKey参数取值对应列表里面的“名称”一列。
|
||
|
||
* @~english
|
||
* @brief Set Integer value
|
||
* @param handle [IN] Device handle
|
||
* @param strKey [IN] Key value, for example, using "Width" to set width
|
||
* @param nValue [IN] Feature value to set
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks You can call this API to set the value of camera node with integer type after connecting the device. For strKey value, refer to MvCameraNode. All the node values of "IInteger" in the list can be obtained via this API. strKey corresponds to the Name column.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetIntValue(IN void* handle,IN const char* strKey,IN unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置Integer型属性值
|
||
* @param handle [IN] 设备句柄
|
||
* @param strKey [IN] 属性键值，如获取宽度信息则为"Width"
|
||
* @param nValue [IN] 想要设置的相机的属性值
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 连接设备之后调用该接口可以设置int类型的指定节点的值。strKey取值可以参考XML节点参数类型列表，表格里面数据类型为“IInteger”的节点值都可以通过该接口设置，strKey参数取值对应列表里面的“名称”一列。
|
||
|
||
* @~english
|
||
* @brief Set Integer value
|
||
* @param handle [IN] Device handle
|
||
* @param strKey [IN] Key value, for example, using "Width" to set width
|
||
* @param nValue [IN] Feature value to set
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks You can call this API to set the value of camera node with integer type after connecting the device. For strKey value, refer to MvCameraNode. All the node values of "IInteger" in the list can be obtained via this API. strKey corresponds to the Name column.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetIntValueEx(IN void* handle,IN const char* strKey,IN int64_t nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取Enum属性值
|
||
* @param handle [IN] 设备句柄
|
||
* @param strKey [IN] 属性键值，如获取像素格式信息则为"PixelFormat"
|
||
* @param pEnumValue [IN][OUT] 返回给调用者有关相机属性结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 连接设备之后调用该接口可以获取Enum类型的指定节点的值。strKey取值可以参考XML节点参数类型列表，表格里面数据类型为“IEnumeration”的节点值都可以通过该接口获取，strKey参数取值对应列表里面的“名称”一列。
|
||
|
||
* @~english
|
||
* @brief Get Enum value
|
||
* @param handle [IN] Device handle
|
||
* @param strKey [IN] Key value, for example, using "PixelFormat" to get pixel format
|
||
* @param pEnumValue [IN][OUT] Structure pointer of camera features
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks After the device is connected, call this interface to get specified Enum nodes. For value of strKey, see MvCameraNode, The node values of IEnumeration can be obtained through this interface, strKey value corresponds to the Name column.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetEnumValue(IN void* handle,IN const char* strKey,OUT MVCC_ENUMVALUE *pEnumValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置Enum型属性值
|
||
* @param handle [IN] 设备句柄
|
||
* @param strKey [IN] 属性键值，如获取像素格式信息则为"PixelFormat"
|
||
* @param nValue [IN] 想要设置的相机的属性值
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 连接设备之后调用该接口可以设置Enum类型的指定节点的值。strKey取值可以参考XML节点参数类型列表，表格里面数据类型为“IEnumeration”的节点值都可以通过该接口设置，strKey参数取值对应列表里面的“名称”一列。
|
||
|
||
* @~english
|
||
* @brief Set Enum value
|
||
* @param handle [IN] Device handle
|
||
* @param strKey [IN] Key value, for example, using "PixelFormat" to set pixel format
|
||
* @param nValue [IN] Feature value to set
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks After the device is connected, call this interface to set specified Enum nodes. For value of strKey, see MvCameraNode, The node values of IEnumeration can be obtained through this interface, strKey value corresponds to the Name column.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetEnumValue(IN void* handle,IN const char* strKey,IN unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置Enum型属性值
|
||
* @param handle [IN] 设备句柄
|
||
* @param strKey [IN] 属性键值，如获取像素格式信息则为"PixelFormat"
|
||
* @param sValue [IN] 想要设置的相机的属性字符串
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 连接设备之后调用该接口可以设置Enum类型的指定节点的值。strKey取值可以参考XML节点参数类型列表，表格里面数据类型为“IEnumeration”的节点值都可以通过该接口设置，strKey参数取值对应列表里面的“名称”一列。
|
||
|
||
* @~english
|
||
* @brief Set Enum value
|
||
* @param handle [IN] Device handle
|
||
* @param strKey [IN] Key value, for example, using "PixelFormat" to set pixel format
|
||
* @param sValue [IN] Feature String to set
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Call this API after connecting the device. All the values of nodes with IEnumeration type can be set via this API.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetEnumValueByString(IN void* handle,IN const char* strKey,IN const char* sValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取Float属性值
|
||
* @param handle [IN] 设备句柄
|
||
* @param strKey [IN] 属性键值
|
||
* @param pFloatValue [IN][OUT] 返回给调用者有关相机属性结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 连接设备之后调用该接口可以获取float类型的指定节点的值。strKey取值可以参考XML节点参数类型列表，表格里面数据类型为“IFloat”的节点值都可以通过该接口获取，strKey参数取值对应列表里面的“名称”一列。
|
||
|
||
* @~english
|
||
* @brief Get Float value
|
||
* @param handle [IN] Device handle
|
||
* @param strKey [IN] Key value
|
||
* @param pFloatValue [IN][OUT] Structure pointer of camera features
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks After the device is connected, call this interface to get specified float node. For detailed strKey value see: MvCameraNode. The node values of IFloat can be obtained through this interface, strKey value corresponds to the Name column.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetFloatValue(IN void* handle,IN const char* strKey,OUT MVCC_FLOATVALUE *pFloatValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置float型属性值
|
||
* @param handle [IN] 设备句柄
|
||
* @param strKey [IN] 属性键值
|
||
* @param fValue [IN] 想要设置的相机的属性值
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 连接设备之后调用该接口可以设置float类型的指定节点的值。strKey取值可以参考XML节点参数类型列表，表格里面数据类型为“IFloat”的节点值都可以通过该接口设置，strKey参数取值对应列表里面的“名称”一列。
|
||
|
||
* @~english
|
||
* @brief Set float value
|
||
* @param handle [IN] Device handle
|
||
* @param strKey [IN] Key value
|
||
* @param fValue [IN] Feature value to set
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks After the device is connected, call this interface to set specified float node. For detailed strKey value see: MvCameraNode. The node values of IFloat can be set through this interface, strKey value corresponds to the Name column.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetFloatValue(IN void* handle,IN const char* strKey,IN float fValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取Boolean属性值
|
||
* @param handle [IN] 设备句柄
|
||
* @param strKey [IN] 属性键值
|
||
* @param pBoolValue [IN][OUT] 返回给调用者有关相机属性值
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 连接设备之后调用该接口可以获取bool类型的指定节点的值。strKey取值可以参考XML节点参数类型列表，表格里面数据类型为“IBoolean”的节点值都可以通过该接口获取，strKey参数取值对应列表里面的“名称”一列。
|
||
|
||
* @~english
|
||
* @brief Get Boolean value
|
||
* @param handle [IN] Device handle
|
||
* @param strKey [IN] Key value
|
||
* @param pBoolValue [IN][OUT] Structure pointer of camera features
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks After the device is connected, call this interface to get specified bool nodes. For value of strKey, see MvCameraNode. The node values of IBoolean can be obtained through this interface, strKey value corresponds to the Name column.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetBoolValue(IN void* handle,IN const char* strKey,OUT bool *pBoolValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置Boolean型属性值
|
||
* @param handle [IN] 设备句柄
|
||
* @param strKey [IN] 属性键值
|
||
* @param bValue [IN] 想要设置的相机的属性值
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 连接设备之后调用该接口可以设置bool类型的指定节点的值。strKey取值可以参考XML节点参数类型列表，表格里面数据类型为“IBoolean”的节点值都可以通过该接口设置，strKey参数取值对应列表里面的“名称”一列。
|
||
|
||
* @~english
|
||
* @brief Set Boolean value
|
||
* @param handle [IN] Device handle
|
||
* @param strKey [IN] Key value
|
||
* @param bValue [IN] Feature value to set
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks After the device is connected, call this interface to set specified bool nodes. For value of strKey, see MvCameraNode. The node values of IBoolean can be set through this interface, strKey value corresponds to the Name column.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetBoolValue(IN void* handle,IN const char* strKey,IN bool bValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取String属性值
|
||
* @param handle [IN] 设备句柄
|
||
* @param strKey [IN] 属性键值
|
||
* @param pStringValue [IN][OUT] 返回给调用者有关相机属性结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 连接设备之后调用该接口可以获取string类型的指定节点的值。strKey取值可以参考XML节点参数类型列表，表格里面数据类型为“IString”的节点值都可以通过该接口获取，strKey参数取值对应列表里面的“名称”一列。
|
||
|
||
* @~english
|
||
* @brief Get String value
|
||
* @param handle [IN] Device handle
|
||
* @param strKey [IN] Key value
|
||
* @param pStringValue [IN][OUT] Structure pointer of camera features
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks After the device is connected, call this interface to get specified string nodes. For value of strKey, see MvCameraNode. The node values of IString can be obtained through this interface, strKey value corresponds to the Name column.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetStringValue(IN void* handle,IN const char* strKey,OUT MVCC_STRINGVALUE *pStringValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置String型属性值
|
||
* @param handle [IN] 设备句柄
|
||
* @param strKey [IN] 属性键值
|
||
* @param sValue [IN] 想要设置的相机的属性值
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 连接设备之后调用该接口可以设置string类型的指定节点的值。strKey取值可以参考XML节点参数类型列表，表格里面数据类型为“IString”的节点值都可以通过该接口设置，strKey参数取值对应列表里面的“名称”一列。
|
||
|
||
* @~english
|
||
* @brief Set String value
|
||
* @param handle [IN] Device handle
|
||
* @param strKey [IN] Key value
|
||
* @param sValue [IN] Feature value to set
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks After the device is connected, call this interface to set specified string nodes. For value of strKey, see MvCameraNode. The node values of IString can be set through this interface, strKey value corresponds to the Name column.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetStringValue(IN void* handle,IN const char* strKey,IN const char * sValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置Command型属性值
|
||
* @param handle [IN] 设备句柄
|
||
* @param strKey [IN] 属性键值
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 连接设备之后调用该接口可以设置指定的Command类型节点。strKey取值可以参考XML节点参数类型列表，表格里面数据类型为“ICommand”的节点都可以通过该接口设置，strKey参数取值对应列表里面的“名称”一列。
|
||
|
||
* @~english
|
||
* @brief Send Command
|
||
* @param handle [IN] Device handle
|
||
* @param strKey [IN] Key value
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks After the device is connected, call this interface to set specified Command nodes. For value of strKey, see MvCameraNode. The node values of ICommand can be set through this interface, strKey value corresponds to the Name column.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetCommandValue(IN void* handle,IN const char* strKey);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 清除GenICam节点缓存
|
||
* @param handle [IN] 设备句柄
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
|
||
* @~english
|
||
* @brief Invalidate GenICam Nodes
|
||
* @param handle [IN] Device handle
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_InvalidateNodes(IN void* handle);
|
||
|
||
|
||
/************************************************************************/
|
||
/* 设备升级 和 寄存器读写 和异常、事件回调 */
|
||
/* Device upgrade, register read and write and exception callback */
|
||
/************************************************************************/
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设备本地升级
|
||
* @param handle [IN] 设备句柄
|
||
* @param pFilePathName [IN] 文件名
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 通过该接口可以将升级固件文件发送给设备进行升级。该接口需要等待升级固件文件成功传给设备端之后再返回，响应时间可能较长。
|
||
|
||
* @~english
|
||
* @brief Device Local Upgrade
|
||
* @param handle [IN] Device handle
|
||
* @param pFilePathName [IN] File name
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_LocalUpgrade(IN void* handle, const void *pFilePathName);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取升级进度
|
||
* @param handle [IN] 设备句柄
|
||
* @param pnProcess [OUT] 进度接收地址
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 获取升级进度百分值。
|
||
|
||
* @~english
|
||
* @brief Get Upgrade Progress
|
||
* @param handle [IN] Device handle
|
||
* @param pnProcess [OUT] Progress receiving address
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Call this API to send the upgrade firmware to the device for upgrade. This API will wait for return until the upgrade firmware is sent to the device, this response may take a long time. \n
|
||
For CameraLink device, it keeps sending upgrade firmware continuously.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetUpgradeProcess(IN void* handle, unsigned int* pnProcess);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 读内存
|
||
* @param handle [IN] 设备句柄
|
||
* @param pBuffer [IN][OUT] 作为返回值使用，保存读到的内存值（内存值是按照大端模式存储的）
|
||
* @param nAddress [IN] 待读取的内存地址，该地址可以从设备的Camera.xml文件中获取，形如xxx_RegAddr的xml节点值
|
||
* @param nLength [IN] 待读取的内存长度
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 访问设备，读取某段寄存器的数据。
|
||
|
||
* @~english
|
||
* @brief Read Memory
|
||
* @param handle [IN] Device Handle
|
||
* @param pBuffer [IN][OUT] Used as a return value, save the read-in memory value ( Memory value is stored in accordance with the big end model)
|
||
* @param nAddress [IN] Memory address to be read, which can be obtained from the Camera.xml file of the device, the form xml node value of xxx_RegAddr
|
||
* @param nLength [IN] Length of the memory to be read
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Access device, read the data from certain register.
|
||
*************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_ReadMemory(IN void* handle , void *pBuffer, int64_t nAddress, int64_t nLength);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 写内存
|
||
* @param handle [IN] 设备句柄
|
||
* @param pBuffer [IN] 待写入的内存值（注意内存值要按照大端模式存储）
|
||
* @param nAddress [IN] 待写入的内存地址，该地址可以从设备的Camera.xml文件中获取，形如xxx_RegAddr的xml节点值
|
||
* @param nLength [IN] 待写入的内存长度
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 访问设备，把一段数据写入某段寄存器。
|
||
|
||
* @~english
|
||
* @brief Write Memory
|
||
* @param handle [IN] Device Handle
|
||
* @param pBuffer [IN] Memory value to be written ( Note the memory value to be stored in accordance with the big end model)
|
||
* @param nAddress [IN] Memory address to be written, which can be obtained from the Camera.xml file of the device, the form xml node value of xxx_RegAddr
|
||
* @param nLength [IN] Length of the memory to be written
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Access device, write a piece of data into a certain segment of register.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_WriteMemory(IN void* handle , const void *pBuffer, int64_t nAddress, int64_t nLength);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 注册异常消息回调，在打开设备之后调用
|
||
* @param handle [IN] 设备句柄
|
||
* @param cbException [IN] 异常回调函数指针
|
||
* @param pUser [IN] 用户自定义变量
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 该接口需要在MV_CC_OpenDevice打开设备之后调用。设备异常断开连接后可以在回调里面获取到异常消息，GigE设备掉线之后需要先调用MV_CC_CloseDevice接口关闭设备，再调用MV_CC_OpenDevice接口重新打开设备。
|
||
|
||
* @~english
|
||
* @brief Register Exception Message CallBack, call after open device
|
||
* @param handle [IN] Device handle
|
||
* @param cbException [IN] Exception Message CallBack Function Pointer
|
||
* @param pUser [IN] User defined variable
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Call this interface after the device is opened by MV_CC_OpenDevice. When device is exceptionally disconnected, the exception message can be obtained from callback function. For Disconnected GigE device, first call MV_CC_CloseDevice to shut device, and then call MV_CC_OpenDevice to reopen the device.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_RegisterExceptionCallBack(IN void* handle,
|
||
void(__stdcall* cbException)(unsigned int nMsgType, void* pUser), void* pUser);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 注册全部事件回调，在打开设备之后调用
|
||
* @param handle [IN] 设备句柄
|
||
* @param cbEvent [IN] 事件回调函数指针
|
||
* @param pUser [IN] 用户自定义变量
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 通过该接口设置事件回调，可以在回调函数里面获取采集、曝光等事件信息。 \n
|
||
该接口不支持CameraLink设备。\n
|
||
该接口仅在windows版本和Linux版本下支持。
|
||
|
||
* @~english
|
||
* @brief Register event callback, which is called after the device is opened
|
||
* @param handle [IN] Device handle
|
||
* @param cbEvent [IN] Event CallBack Function Pointer
|
||
* @param pUser [IN] User defined variable
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Call this API to set the event callback function to get the event information, e.g., acquisition, exposure, and so on. \n
|
||
This API is not supported by CameraLink device.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_RegisterAllEventCallBack(void* handle, void(__stdcall* cbEvent)(MV_EVENT_OUT_INFO * pEventInfo, void* pUser), void* pUser);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 注册单个事件回调，在打开设备之后调用
|
||
* @param handle [IN] 设备句柄
|
||
* @param pEventName [IN] 事件名称
|
||
* @param cbEvent [IN] 事件回调函数指针
|
||
* @param pUser [IN] 用户自定义变量
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 通过该接口设置事件回调，可以在回调函数里面获取采集、曝光等事件信息。\n
|
||
该接口不支持CameraLink设备，仅支持"设备掉线"这一种事件。
|
||
|
||
* @~english
|
||
* @brief Register single event callback, which is called after the device is opened
|
||
* @param handle [IN] Device handle
|
||
* @param pEventName [IN] Event name
|
||
* @param cbEvent [IN] Event CallBack Function Pointer
|
||
* @param pUser [IN] User defined variable
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Call this API to set the event callback function to get the event information, e.g., acquisition, exposure, and so on. \n
|
||
This API is not supported by CameraLink device .
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_RegisterEventCallBackEx(void* handle, const char* pEventName,
|
||
void(__stdcall* cbEvent)(MV_EVENT_OUT_INFO * pEventInfo, void* pUser), void* pUser);
|
||
|
||
|
||
/************************************************************************/
|
||
/* GigEVision 设备独有的接口 */
|
||
/* GigEVision device specific interface */
|
||
/************************************************************************/
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 强制IP
|
||
* @param handle [IN] 设备句柄
|
||
* @param nIP [IN] 设置的IP
|
||
* @param nSubNetMask [IN] 子网掩码
|
||
* @param nDefaultGateWay [IN] 默认网关
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 强制设置相机网络参数（包括IP、子网掩码、默认网关），强制设置之后将需要重新创建设备句柄，仅GigEVision相机支持。\n
|
||
如果设备为DHCP的状态，调用该接口强制设置相机网络参数之后设备将会重启。
|
||
|
||
* @~english
|
||
* @brief Force IP
|
||
* @param handle [IN] Device handle
|
||
* @param nIP [IN] IP to set
|
||
* @param nSubNetMask [IN] Subnet mask
|
||
* @param nDefaultGateWay [IN] Default gateway
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Force setting camera network parameter (including IP address, subnet mask, default gateway). After forced setting, device handle should be created again. This function is only supported by GigEVision camera.\n
|
||
If device is in DHCP status, after calling this API to force setting camera network parameter, the device will restart.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_ForceIpEx(IN void* handle, unsigned int nIP, unsigned int nSubNetMask, unsigned int nDefaultGateWay);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 配置IP方式
|
||
* @param handle [IN] 设备句柄
|
||
* @param nType [IN] IP类型，见MV_IP_CFG_x
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 发送命令设置相机的IP方式，如DHCP、LLA等，仅GigEVision相机支持。
|
||
|
||
* @~english
|
||
* @brief IP configuration method
|
||
* @param handle [IN] Device handle
|
||
* @param nType [IN] IP type, refer to MV_IP_CFG_x
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Send command to set camera IP mode, such as DHCP and LLA, only supported by GigEVision.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_SetIpConfig(IN void* handle, unsigned int nType);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置仅使用某种模式,type: MV_NET_TRANS_x，不设置时，默认优先使用driver
|
||
* @param handle [IN] 设备句柄
|
||
* @param nType [IN] 网络传输模式，见MV_NET_TRANS_x
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 通过该接口可以设置SDK内部优先使用的网络模式，默认优先使用驱动模式，仅GigEVision相机支持。
|
||
|
||
* @~english
|
||
* @brief Set to use only one mode,type: MV_NET_TRANS_x. When do not set, priority is to use driver by default
|
||
* @param handle [IN] Device handle
|
||
* @param nType [IN] Net transmission mode, refer to MV_NET_TRANS_x
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarksSet SDK internal priority network mode through this interface, drive mode by default, only supported by GigEVision camera.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_SetNetTransMode(IN void* handle, unsigned int nType);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取网络传输信息
|
||
* @param handle [IN] 设备句柄
|
||
* @param pstInfo [OUT] 信息结构体
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 通过该接口可以获取网络传输相关信息，包括已接收数据大小、丢帧数量等，在MV_CC_StartGrabbing开启采集之后调用。仅GigEVision相机支持。
|
||
|
||
* @~english
|
||
* @brief Get net transmission information
|
||
* @param handle [IN] Device handle
|
||
* @param pstInfo [OUT] Information Structure
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Get network transmission information through this API, including received data size, number of lost frames. Call this API after starting image acquiring through MV_CC_StartGrabbing. This API is supported only by GigEVision Camera.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_GetNetTransInfo(IN void* handle, MV_NETTRANS_INFO* pstInfo);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置GVSP取流超时时间
|
||
* @param handle [IN] 设备句柄
|
||
* @param nMillisec [IN] 超时时间，默认300ms，范围：>10ms
|
||
* @return 成功，返回MV_OK；错误，返回错误码
|
||
* @remarks 连接设备之后，取流动作发生前，调用该接口可以设置GVSP取流超时时间。GVSP取流超时设置过短可能造成图像异常，设置过长可能造成取流时间变长。
|
||
|
||
* @~english
|
||
* @brief Set GVSP streaming timeout
|
||
* @param handle [IN] Device handle
|
||
* @param nMillisec [IN] Timeout, default 300ms, range: >10ms
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks After the device is connected, and just before start streaming,
|
||
* call this interface to set GVSP streaming timeout value.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_SetGvspTimeout(void* handle, unsigned int nMillisec);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取GVSP取流超时时间
|
||
* @param handle [IN] 设备句柄
|
||
* @param pnMillisec [IN] 超时时间指针，以毫秒位单位
|
||
* @return 成功，返回MV_OK；错误，返回错误码
|
||
* @remarks 该接口用于获取当前的GVSP取流超时时间
|
||
|
||
* @~english
|
||
* @brief Get GVSP streaming timeout
|
||
* @param handle [IN] Device handle
|
||
* @param pnMillisec [IN] Timeout, ms as unit
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks This interface is used to get the current GVSP streaming timeout.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_GetGvspTimeout(IN void* handle, unsigned int* pnMillisec);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置GVCP命令超时时间
|
||
* @param handle [IN] 设备句柄
|
||
* @param nMillisec [IN] 超时时间，默认500ms，范围：0-10000ms
|
||
* @return 成功，返回MV_OK；错误，返回错误码
|
||
* @remarks 连接设备之后调用该接口可以设置GVCP命令超时时间。
|
||
|
||
* @~english
|
||
* @brief Set GVCP cammand timeout
|
||
* @param handle [IN] Device handle
|
||
* @param nMillisec [IN] Timeout, default 500ms, range: 0-10000ms
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks After the device is connected, call this interface to set GVCP command timeout time.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_SetGvcpTimeout(void* handle, unsigned int nMillisec);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取GVCP命令超时时间
|
||
* @param handle [IN] 设备句柄
|
||
* @param pnMillisec [OUT] 超时时间指针，以毫秒位单位
|
||
* @return 成功，返回MV_OK；错误，返回错误码
|
||
* @remarks 该接口用于获取当前的GVCP超时时间。
|
||
|
||
* @~english
|
||
* @brief Get GVCP cammand timeout
|
||
* @param handle [IN] Device handle
|
||
* @param pnMillisec [OUT] Timeout, ms as unit
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks This interface is used to get the current GVCP timeout.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_GetGvcpTimeout(IN void* handle, unsigned int* pnMillisec);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置重传GVCP命令次数
|
||
* @param handle [IN] 设备句柄
|
||
* @param nRetryGvcpTimes [IN] 重传次数，范围：0-100
|
||
* @return 成功，返回MV_OK；错误，返回错误码
|
||
* @remarks 该接口用于在GVCP包传输异常时，增加重传的次数，在一定程度上可以避免设备掉线，范围为0-100。
|
||
|
||
* @~english
|
||
* @brief Set the number of retry GVCP cammand
|
||
* @param handle [IN] Device handle
|
||
* @param nRetryGvcpTimes [IN] The number of retries，rang：0-100
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks This interface is used to increase The Times of retransmission when GVCP packet transmission is abnormal,and to some extent, it can avoid dropping the camera, with a range of 0-100.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_SetRetryGvcpTimes(IN void* handle, unsigned int nRetryGvcpTimes);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取重传GVCP命令次数
|
||
* @param handle [IN] 设备句柄
|
||
* @param pnRetryGvcpTimes [OUT] 重传次数指针
|
||
* @return 成功，返回MV_OK；错误，返回错误码
|
||
* @remarks 该接口用于获取当前的GVCP重传次数，默认3次。
|
||
|
||
* @~english
|
||
* @brief Get the number of retry GVCP cammand
|
||
* @param handle [IN] Device handle
|
||
* @param pnRetryGvcpTimes [OUT] The number of retries
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks This interface is used to get the current number of GVCP retransmissions, which defaults to 3.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_GetRetryGvcpTimes(IN void* handle, unsigned int* pnRetryGvcpTimes);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取最佳的packet size，该接口目前只支持GigE设备
|
||
* @param handle [IN] 设备句柄
|
||
* @return 最佳packetsize
|
||
* @remarks 获取最佳的packet size，对应GigEVision设备是SCPS，对应U3V设备是每次从驱动读取的包大小，该大小即网络上传输一个包的大小。该接口需要在MV_CC_OpenDevice之后、MV_CC_StartGrabbing之前调用。 \n
|
||
该接口不支持CameraLink设备。
|
||
|
||
* @~english
|
||
* @brief Get the optimal Packet Size, Only support GigE Camera
|
||
* @param handle [IN] Device handle
|
||
* @return Optimal packetsize
|
||
* @remarks To get optimized packet size, for GigEVision device is SCPS, for USB3Vision device is the size of packet read from drive each time, and it is the size of a packet transported on the network. The interface should be called after MV_CC_OpenDevice and before MV_CC_StartGrabbing. \n
|
||
This API is not supported by CameraLink device.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetOptimalPacketSize(IN void* handle);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置是否打开重发包支持，及重发包设置
|
||
* @param handle [IN] 设备句柄
|
||
* @param bEnable [IN] 是否支持重发包
|
||
* @param nMaxResendPercent [IN] 最大重发比
|
||
* @param nResendTimeout [IN] 重发超时时间
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 连接设备之后调用该接口可以设置重发包属性，仅GigEVision相机支持。 \n
|
||
该接口仅在windows版本和Linux版本下支持。
|
||
|
||
* @~english
|
||
* @brief Set whethe to enable resend, and set resend
|
||
* @param handle [IN] Device handle
|
||
* @param bEnable [IN] enable resend
|
||
* @param nMaxResendPercent [IN] Max resend persent
|
||
* @param nResendTimeout [IN] Resend timeout
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks After the device is connected, call this interface to set resend packet properties, only supported by GigEVision camera.
|
||
************************************************************************/
|
||
#ifndef __cplusplus
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_SetResend(void* handle, unsigned int bEnable, unsigned int nMaxResendPercent, unsigned int nResendTimeout);
|
||
#else
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_SetResend(void* handle, unsigned int bEnable, unsigned int nMaxResendPercent = 10, unsigned int nResendTimeout = 50);
|
||
#endif
|
||
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置重传命令最大尝试次数
|
||
* @param handle [IN] 设备句柄
|
||
* @param nRetryTimes [IN] 重传命令最大尝试次数，默认20
|
||
* @return 成功，返回MV_OK；错误，返回错误码
|
||
* @remarks 该接口必须在MV_CC_StartGrabbing之前调用，否则返回错误码MV_E_CALLORDER。
|
||
|
||
* @~english
|
||
* @brief set the max resend retry times
|
||
* @param handle [IN] Device handle
|
||
* @param nRetryTimes [IN] the max times to retry resending lost packets，default 20
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks This interface must be called before MV_CC_StartGrabbing. Otherwise return MV_E_CALLORDER.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_SetResendMaxRetryTimes(void* handle, unsigned int nRetryTimes);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取重传命令最大尝试次数
|
||
* @param handle [IN] 设备句柄
|
||
* @param pnRetryTimes [IN] 重传命令最大尝试次数
|
||
* @return 成功，返回MV_OK；错误，返回错误码
|
||
|
||
* @~english
|
||
* @brief get the max resend retry times
|
||
* @param handle [IN] Device handle
|
||
* @param pnRetryTimes [OUT] the max times to retry resending lost packets
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_GetResendMaxRetryTimes(void* handle, unsigned int* pnRetryTimes);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置同一重传包多次请求之间的时间间隔
|
||
* @param handle [IN] 设备句柄
|
||
* @param nMillisec [IN] 同一重传包多次请求之间的时间间隔，默认10ms
|
||
* @return 成功，返回MV_OK；错误，返回错误码
|
||
* @remarks 该接口必须在MV_CC_StartGrabbing之前调用，否则返回错误码MV_E_CALLORDER。
|
||
|
||
* @~english
|
||
* @brief set time interval between same resend requests
|
||
* @param handle [IN] Device handle
|
||
* @param nMillisec [OUT] the time interval between same resend requests, default 10ms
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks This interface must be called before MV_CC_StartGrabbing. Otherwise return MV_E_CALLORDER.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_SetResendTimeInterval(void* handle, unsigned int nMillisec);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取同一重传包多次请求之间的时间间隔
|
||
* @param handle [IN] 设备句柄
|
||
* @param pnMillisec [IN] 同一重传包多次请求之间的时间间隔
|
||
* @return 成功，返回MV_OK；错误，返回错误码
|
||
|
||
* @~english
|
||
* @brief get time interval between same resend requests
|
||
* @param handle [IN] Device handle
|
||
* @param pnMillisec [OUT] the time interval between same resend requests
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_GetResendTimeInterval(void* handle, unsigned int* pnMillisec);
|
||
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置传输模式，可以为单播模式、组播模式等
|
||
* @param handle [IN] 设备句柄
|
||
* @param pstTransmissionType [IN] 传输模式结构体
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 通过该接口可以设置传输模式为单播、组播等模式，仅GigEVision相机支持。
|
||
|
||
* @~english
|
||
* @brief Set transmission type,Unicast or Multicast
|
||
* @param handle [IN] Device handle
|
||
* @param pstTransmissionType [IN] Struct of transmission type
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Call this API to set the transmission mode as single cast mode and multicast mode. And this API is only valid for GigEVision camera.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_SetTransmissionType(void* handle, MV_TRANSMISSION_TYPE * pstTransmissionType);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 发出动作命令
|
||
* @param pstActionCmdInfo [IN] 动作命令信息
|
||
* @param pstActionCmdResults [OUT] 动作命令返回信息列表
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 仅GigEVision相机支持。
|
||
|
||
* @~english
|
||
* @brief Issue Action Command
|
||
* @param pstActionCmdInfo [IN] Action Command
|
||
* @param pstActionCmdResults [OUT] Action Command Result List
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks This API is supported only by GigEVision camera.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_IssueActionCommand(IN MV_ACTION_CMD_INFO* pstActionCmdInfo, OUT MV_ACTION_CMD_RESULT_LIST* pstActionCmdResults);
|
||
|
||
/************************************************************************/
|
||
/* XML解析树的生成 */
|
||
/* XML parse tree generation */
|
||
/************************************************************************/
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取相机属性树XML
|
||
* @param handle [IN] 设备句柄
|
||
* @param pData [OUT] XML数据接收缓存
|
||
* @param nDataSize [IN] 接收缓存大小
|
||
* @param pnDataLen [OUT] 实际数据大小
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 当pData为NULL或nDataSize比实际的xml文件小时，不拷贝数据，由pnDataLen返回xml文件大小；\n
|
||
当pData为有效缓存地址，且缓存足够大时，拷贝完整数据保存在该缓存里面，并由pnDataLen返回xml文件实际大小。
|
||
|
||
* @~english
|
||
* @brief Get camera feature tree XML
|
||
* @param handle [IN] Device handle
|
||
* @param pData [OUT] XML data receiving buffer
|
||
* @param nDataSize [IN] Buffer size
|
||
* @param pnDataLen [OUT] Actual data length
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks * @remarks When pData is NULL or nDataSize than the actual XML file hours, do not copy the data, returned by pnDataLen XML file size.\n
|
||
When pData is a valid cache address and the cache is large enough, copy the full data into the cache, and pnDataLen returns the actual size of the XML file.
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_XML_GetGenICamXML(IN void* handle, IN OUT unsigned char* pData, IN unsigned int nDataSize, OUT unsigned int* pnDataLen);
|
||
|
||
/************************************************************************/
|
||
/* 附加接口 */
|
||
/* Additional interface */
|
||
/************************************************************************/
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 保存图片，支持Bmp和Jpeg.编码质量在50-99之前
|
||
* @param handle [IN] 设备句柄
|
||
* @param pSaveParam [IN][OUT] 保存图片参数结构体
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 通过将接口可以将从设备采集到的原始图像数据转换成JPEG或者BMP等格式并存放在指定内存中，然后用户可以将转换之后的数据直接保存成图片文件。该接口调用无接口顺序要求，有图像源数据就可以进行转换，可以先调用MV_CC_GetOneFrameTimeout或者MV_CC_RegisterImageCallBackEx设置回调函数，获取一帧图像数据，然后再通过该接口转换格式。 \n
|
||
MV_CC_SaveImageEx2比MV_CC_SaveImageEx增加参数handle，为了保证与其他接口的统一。\n
|
||
该接口仅在windows版本和Linux版本下支持。
|
||
|
||
* @~english
|
||
* @brief Save image, support Bmp and Jpeg. Encoding quality(50-99]
|
||
* @param handle [IN] Device handle
|
||
* @param pSaveParam [IN][OUT] Save image parameters structure
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Once there is image data, you can call this API to convert the data. \n
|
||
You can also call MV_CC_GetOneFrameTimeout or MV_CC_RegisterImageCallBackEx or MV_CC_GetImageBuffer to get one image frame and set the callback function, and then call this API to convert the format. \n
|
||
Comparing with the API MV_CC_SaveImageEx, this API added the parameter handle to ensure the unity with other API.
|
||
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SaveImageEx2(IN void* handle, MV_SAVE_IMAGE_PARAM_EX* pSaveParam);
|
||
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 图像旋转
|
||
* @param handle [IN] 设备句柄
|
||
* @param pstRotateParam [IN][OUT] 图像旋转参数结构体
|
||
* @return 成功，返回MV_OK；错误，返回错误码
|
||
* @remarks 该接口只支持MONO8/RGB24/BGR24格式数据的90/180/270度旋转。
|
||
|
||
* @~english
|
||
* @brief Rotate Image
|
||
* @param handle [IN] Device handle
|
||
* @param pstRotateParam [IN][OUT] Rotate image parameter structure
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks This API only support 90/180/270 rotation of data in the MONO8/RGB24/BGR24 format.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_RotateImage(IN void* handle, IN OUT MV_CC_ROTATE_IMAGE_PARAM* pstRotateParam);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 图像翻转
|
||
* @param handle [IN] 设备句柄
|
||
* @param pstFlipParam [IN][OUT] 图像翻转参数结构体
|
||
* @return 成功，返回MV_OK；错误，返回错误码
|
||
* @remarks 该接口只支持MONO8/RGB24/BGR24格式数据的垂直和水平翻转。
|
||
|
||
* @~english
|
||
* @brief Flip Image
|
||
* @param handle [IN] Device handle
|
||
* @param pstFlipParam [IN][OUT] Flip image parameter structure
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks This API only support vertical and horizontal reverse of data in the MONO8/RGB24/BGR24 format.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_FlipImage(IN void* handle, IN OUT MV_CC_FLIP_IMAGE_PARAM* pstFlipParam);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 像素格式转换
|
||
* @param handle [IN] 设备句柄
|
||
* @param pstCvtParam [IN][OUT] 像素格式转换参数结构体
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 通过将接口可以将从设备采集到的原始图像数据转换成用户所需的像素格式并存放在指定内存中。该接口调用无接口顺序要求，有图像源数据就可以进行转换，可以先调用MV_CC_GetOneFrameTimeout或者MV_CC_RegisterImageCallBack设置回调函数，获取一帧图像数据，然后再通过该接口转换格式。如果相机当前采集图像是JPEG压缩的格式，则不支持调用该接口进行显示。 \n
|
||
该接口仅在windows版本和Linux版本下支持。
|
||
|
||
* @~english
|
||
* @brief Pixel format conversion
|
||
* @param handle [IN] Device handle
|
||
* @param pstCvtParam [IN][OUT] Convert Pixel Type parameter structure
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks This API is used to transform the collected original data to pixel format and save to specified memory. There is no order requirement to call this API, the transformation will execute when there is image data. First call MV_CC_GetOneFrameTimeout or MV_CC_RegisterImageCallBackEx to set callback function, and get a frame of image data, then call this API to transform the format. \n
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_ConvertPixelType(IN void* handle, IN OUT MV_CC_PIXEL_CONVERT_PARAM* pstCvtParam);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 插值算法类型设置
|
||
* @param handle [IN] 设备句柄
|
||
* @param BayerCvtQuality [IN] Bayer的插值方法 0-最近邻 1-双线性 2-Hamilton
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks 设置内部图像转换接口的贝尔插值质量参数，MV_CC_ConvertPixelType、MV_CC_SaveImageEx2接口内部使用的插值算法是该接口所设定的。
|
||
|
||
* @~english
|
||
* @brief Interpolation algorithm type setting
|
||
* @param handle [IN] Device handle
|
||
* @param BayerCvtQuality [IN] Bayer interpolation method 0-nearest neighbour 1-bilinearity 2-Hamilton
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Set the bell interpolation quality parameters of the internal image conversion interface, and the interpolation algorithm used in the MV CC ConvertPixelType and MV CC SaveImageEx2 interfaces is set by this interface.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetBayerCvtQuality(IN void* handle, IN unsigned int BayerCvtQuality);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置Bayer格式的Gamma信息
|
||
* @param handle [IN] 设备句柄
|
||
* @param pstGammaParam [IN] Gamma信息
|
||
* @return 成功，返回MV_OK；错误，返回错误码
|
||
* @remarks 设置该信息后，在调用MV_CC_ConvertPixelType、MV_CC_SaveImageEx2接口将Bayer8/10/12/16格式转成RGB24/48， RGBA32/64，BGR24/48，BGRA32/64时起效。
|
||
|
||
* @~english
|
||
* @brief Set Gamma param
|
||
* @param handle [IN] Device handle
|
||
* @param pstGammaParam [IN] Gamma param
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks After setting the param, it work in the calling MV_CC_ConvertPixelType\MV_CC_SaveImageEx2 API convert Bayer8/10/12/16 to RGB24/48， RGBA32/64，BGR24/48，BGRA32/64.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetBayerGammaParam(IN void* handle, IN MV_CC_GAMMA_PARAM* pstGammaParam);
|
||
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 无损解码
|
||
* @param handle [IN] 设备句柄
|
||
* @param pstDecodeParam [IN][OUT] 无损解码参数结构体
|
||
* @return 成功，返回MV_OK；错误，返回错误码
|
||
* @remarks 将从相机中取到的无损压缩码流解码成裸数据，同时支持解析当前相机实时图像的水印信息（如果输入的无损码流不是当前相机或者不是实时取流的，则水印解析可能异常）
|
||
|
||
* @~english
|
||
* @brief High Bandwidth Decode
|
||
* @param handle [IN] Device handle
|
||
* @param pstDecodeParam [IN][OUT] High Bandwidth Decode parameter structure
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks Decode the lossless compressed data from the camera into raw data
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_HB_Decode(IN void* handle, IN OUT MV_CC_HB_DECODE_PARAM* pstDecodeParam);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 保存相机属性
|
||
* @param handle [IN] 设备句柄
|
||
* @param pFileName [IN] 属性文件名
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
|
||
* @~english
|
||
* @brief Save camera feature
|
||
* @param handle [IN] Device handle
|
||
* @param pFileName [IN] File name
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_FeatureSave(IN void* handle, IN const char* pFileName);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 导入相机属性
|
||
* @param handle [IN] 设备句柄
|
||
* @param pFileName [IN] 属性文件名
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
|
||
* @~english
|
||
* @brief Load camera feature
|
||
* @param handle [IN] Device handle
|
||
* @param pFileName [IN] File name
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_FeatureLoad(IN void* handle, IN const char* pFileName);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 从相机读取文件
|
||
* @param handle [IN] 设备句柄
|
||
* @param pstFileAccess [IN] 文件存取结构体
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
|
||
* @~english
|
||
* @brief Read the file from the camera
|
||
* @param handle [IN] Device handle
|
||
* @param pstFileAccess [IN] File access structure
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_FileAccessRead(IN void* handle, IN MV_CC_FILE_ACCESS * pstFileAccess);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 将文件写入相机
|
||
* @param handle [IN] 设备句柄
|
||
* @param pstFileAccess [IN] 文件存取结构体
|
||
* @return 成功，返回#MV_OK ；错误，返回错误码
|
||
|
||
* @~english
|
||
* @brief Write the file to camera
|
||
* @param handle [IN] Device handle
|
||
* @param pstFileAccess [IN] File access structure
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_FileAccessWrite(IN void* handle, IN MV_CC_FILE_ACCESS * pstFileAccess);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取文件存取的进度
|
||
* @param handle [IN] 设备句柄
|
||
* @param pstFileAccessProgress [IN] 进度内容
|
||
* @return 成功，返回#MV_OK ；错误，返回错误码 （当前文件存取的状态）
|
||
|
||
* @~english
|
||
* @brief Get File Access Progress
|
||
* @param handle [IN] Device handle
|
||
* @param pstFileAccessProgress [IN] File access Progress
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetFileAccessProgress(IN void* handle, OUT MV_CC_FILE_ACCESS_PROGRESS * pstFileAccessProgress);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 开始录像
|
||
* @param handle [IN] 设备句柄
|
||
* @param pstRecordParam [IN] 录像参数结构体
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
|
||
* @~english
|
||
* @brief Start Record
|
||
* @param handle [IN] Device handle
|
||
* @param pstRecordParam [IN] Record param structure
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_StartRecord(IN void* handle, IN MV_CC_RECORD_PARAM* pstRecordParam);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 输入录像数据
|
||
* @param handle [IN] 设备句柄
|
||
* @param pstInputFrameInfo [IN] 录像数据结构体
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
|
||
* @~english
|
||
* @brief Input RAW data to Record
|
||
* @param handle [IN] Device handle
|
||
* @param pstInputFrameInfo [IN] Record data structure
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_InputOneFrame(IN void* handle, IN MV_CC_INPUT_FRAME_INFO * pstInputFrameInfo);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 停止录像
|
||
* @param handle [IN] 设备句柄
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Stop Record
|
||
* @param handle [IN] Device handle
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_StopRecord(IN void* handle);
|
||
|
||
|
||
|
||
/************************************************************************/
|
||
/* 不建议使用的接口 */
|
||
/* Interfaces not recommended */
|
||
/************************************************************************/
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取图像基本信息
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstInfo [IN][OUT] 返回给调用者有关相机图像基本信息结构体指针
|
||
* @return 成功,返回 #MV_OK ,失败,返回错误码
|
||
* @remarks 参考 CameraParams.h 中的 #MV_IMAGE_BASIC_INFO 定义
|
||
|
||
* @~english
|
||
* @brief Get basic information of image
|
||
* @param handle [IN] Handle
|
||
* @param pstInfo [IN][OUT] Structure pointer of image basic information
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to the definition of #MV_IMAGE_BASIC_INFO in CameraParams.h
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetImageInfo(IN void* handle, IN OUT MV_IMAGE_BASIC_INFO* pstInfo);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取GenICam代理
|
||
* @param handle [IN] 句柄地址
|
||
* @return GenICam代理类指针 ，正常返回值非NULL；异常返回NULL
|
||
|
||
* @~english
|
||
* @brief Get GenICam proxy
|
||
* @param handle [IN] Handle address
|
||
* @return GenICam proxy pointer, normal, return non-NULL; exception, return NULL
|
||
************************************************************************/
|
||
MV_CAMCTRL_API void* __stdcall MV_CC_GetTlProxy(IN void* handle);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取根节点
|
||
* @param handle [IN] 句柄
|
||
* @param pstNode [OUT] 根节点信息结构体
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Get root node
|
||
* @param handle [IN] Handle
|
||
* @param pstNode [OUT] Root node information structure
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_XML_GetRootNode(IN void* handle, IN OUT MV_XML_NODE_FEATURE* pstNode);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 从xml中获取指定节点的所有子节点，根节点为Root
|
||
* @param handle [IN] 句柄
|
||
* @param pstNode [IN] 根节点信息结构体
|
||
* @param pstNodesList [OUT] 节点列表结构体
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Get all children node of specific node from xml, root node is Root
|
||
* @param handle [IN] Handle
|
||
* @param pstNode [IN] Root node information structure
|
||
* @param pstNodesList [OUT] Node information structure
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_XML_GetChildren(IN void* handle, IN MV_XML_NODE_FEATURE* pstNode, IN OUT MV_XML_NODES_LIST* pstNodesList);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获得当前节点的属性
|
||
* @param handle [IN] 句柄
|
||
* @param pstNode [IN] 根节点信息结构体
|
||
* @param pstFeature [OUT] 当前节点属性结构体，
|
||
pstFeature 具体结构体内容参考 MV_XML_FEATURE_x
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Get current node feature
|
||
* @param handle [IN] Handle
|
||
* @param pstNode [IN] Root node information structure
|
||
* @param pstFeature [OUT] Current node feature structure
|
||
Details of pstFeature refer to MV_XML_FEATURE_x
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_XML_GetNodeFeature(IN void* handle, IN MV_XML_NODE_FEATURE* pstNode, IN OUT void* pstFeature);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 更新节点
|
||
* @param handle [IN] 句柄
|
||
* @param enType [IN] 节点类型
|
||
* @param pstFeature [OUT] 当前节点属性结构体
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Update node
|
||
* @param handle [IN] Handle
|
||
* @param enType [IN] Node type
|
||
* @param pstFeature [OUT] Current node feature structure
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_XML_UpdateNodeFeature(IN void* handle, IN enum MV_XML_InterfaceType enType, IN void* pstFeature);
|
||
|
||
// 有节点需要更新时的回调函数
|
||
// 当调用MV_XML_UpdateNodeFeature接口更新节点属性时，注册的回调函数cbUpdate会在pstNodesList中返回与之相关联的节点
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @fn MV_XML_RegisterUpdateCallBack
|
||
* @brief 注册更新回调
|
||
* @param handle [IN] 句柄
|
||
* @param cbUpdate [IN] 回调函数指针
|
||
* @param pUser [IN] 用户自定义变量
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Register update callback
|
||
* @param handle [IN] Handle
|
||
* @param cbUpdate [IN] Callback function pointer
|
||
* @param pUser [IN] User defined variable
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_XML_RegisterUpdateCallBack(IN void* handle,
|
||
IN void(__stdcall* cbUpdate)(enum MV_XML_InterfaceType enType, void* pstFeature, MV_XML_NODES_LIST* pstNodesList, void* pUser),
|
||
IN void* pUser);
|
||
|
||
|
||
/************************************************************************/
|
||
/* 弃用的接口 */
|
||
/* Abandoned interface */
|
||
/************************************************************************/
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取一帧图像，此函数为查询式获取，每次调用查询内部缓存有
|
||
无数据，有数据则范围数据，无数据返回错误码
|
||
（该接口已弃用，建议改用 MV_CC_GetOneFrameTimeOut接口）
|
||
* @param handle [IN] 句柄
|
||
* @param pData [OUT] 图像数据接收指针
|
||
* @param nDataSize [IN] 接收缓存大小
|
||
* @param pFrameInfo [OUT] 图像信息结构体
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Get one frame data, this function is using query to get data,
|
||
query whether the internal cache has data, return data if there has, return error code if no data
|
||
(This interface is abandoned, it is recommended to use the MV_CC_GetOneFrameTimeOut)
|
||
* @param handle [IN] Handle
|
||
* @param pData [OUT] Recevied image data pointer
|
||
* @param nDataSize [IN] Recevied buffer size
|
||
* @param pFrameInfo [OUT] Image information structure
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetOneFrame(IN void* handle, IN OUT unsigned char * pData , IN unsigned int nDataSize, IN OUT MV_FRAME_OUT_INFO* pFrameInfo);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取一帧trunck数据，此函数为查询式获取，每次调用查询内部
|
||
缓存有无数据，有数据则范围数据，无数据返回错误码
|
||
（该接口已弃用，建议改用 MV_CC_GetOneFrameTimeOut接口）
|
||
* @param handle [IN] 句柄
|
||
* @param pData [OUT] 图像数据接收指针
|
||
* @param nDataSize [IN] 接收缓存大小
|
||
* @param pFrameInfo [OUT] 图像信息结构体
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Get one frame of trunck data, this function is using query to get data,
|
||
query whether the internal cache has data, return data if there has, return error code if no data
|
||
(This interface is abandoned, it is recommended to use the MV_CC_GetOneFrameTimeOut)
|
||
* @param handle [IN] Handle
|
||
* @param pData [OUT] Recevied image data pointer
|
||
* @param nDataSize [IN] Recevied buffer size
|
||
* @param pFrameInfo [OUT] Image information structure
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetOneFrameEx(IN void* handle, IN OUT unsigned char * pData , IN unsigned int nDataSize, IN OUT MV_FRAME_OUT_INFO_EX* pFrameInfo);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 注册图像数据回调（该接口已弃用，建议改用 MV_CC_RegisterImageCallBackEx接口）
|
||
* @param handle [IN] 句柄
|
||
* @param cbOutput [IN] 回调函数指针
|
||
* @param pUser [IN] 用户自定义变量
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Register image data callback (This interface is abandoned, it is recommended to use the MV_CC_RegisterImageCallBackEx)
|
||
* @param handle [IN] Handle
|
||
* @param cbOutput [IN] Callback function pointer
|
||
* @param pUser [IN] User defined variable
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
***********************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_RegisterImageCallBack(void* handle,
|
||
void(__stdcall* cbOutput)(unsigned char * pData, MV_FRAME_OUT_INFO* pFrameInfo, void* pUser),
|
||
void* pUser);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 保存图片（该接口已弃用，建议改用 MV_CC_SaveImageEx2接口）
|
||
* @param pSaveParam [IN][OUT] 保存图片参数结构体
|
||
- pData; // [IN] 输入数据缓存
|
||
- nDataLen; // [IN] 输入数据大小
|
||
- enPixelType; // [IN] 输入数据的像素格式
|
||
- nWidth; // [IN] 图像宽
|
||
- nHeight; // [IN] 图像高
|
||
- pImageBuffer; // [OUT] 输出图片缓存
|
||
- nImageLen; // [OUT] 输出图片大小
|
||
- nBufferSize; // [IN] 提供的输出缓冲区大小
|
||
- enImageType; // [IN] 输出图片格式
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Save image (This interface is abandoned, it is recommended to use the MV_CC_SaveImageEx2)
|
||
* @param pSaveParam [IN][OUT] Save image parameters structure
|
||
- pData; // [IN] Input data buffer
|
||
- nDataLen; // [IN] Input data size
|
||
- enPixelType; // [IN] Input data pixel format
|
||
- nWidth; // [IN] Width
|
||
- nHeight; // [IN] Height
|
||
- pImageBuffer; // [OUT] Output image buffer
|
||
- nImageLen; // [OUT] Output image size
|
||
- nBufferSize; // [IN] Provided output buffer size
|
||
- enImageType; // [IN] Output image type
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SaveImage(IN OUT MV_SAVE_IMAGE_PARAM* pSaveParam);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 保存图片，支持Bmp和Jpeg.编码质量在50-99之前 （该接口已弃用，建议改用 MV_CC_SaveImageEx2接口）
|
||
* @param pSaveParam [IN][OUT] 保存图片参数结构体
|
||
pData; // [IN] 输入数据缓存
|
||
nDataLen; // [IN] 输入数据大小
|
||
enPixelType; // [IN] 输入数据的像素格式
|
||
nWidth; // [IN] 图像宽
|
||
nHeight; // [IN] 图像高
|
||
pImageBuffer; // [OUT] 输出图片缓存
|
||
nImageLen; // [OUT] 输出图片大小
|
||
nBufferSize; // [IN] 提供的输出缓冲区大小
|
||
enImageType; // [IN] 输出图片格式
|
||
nJpgQuality; // [IN] 编码质量, (50-99]
|
||
nReserved[4];
|
||
* @return 成功，返回#MV_OK；错误，返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Save image, support Bmp and Jpeg. Encoding quality, (50-99]
|
||
* @param pSaveParam [IN][OUT] Save image parameters structure
|
||
pData; // [IN] Input data buffer
|
||
nDataLen; // [IN] Input data size
|
||
enPixelType; // [IN] Pixel format of input data
|
||
nWidth; // [IN] Image width
|
||
nHeight; // [IN] Image height
|
||
pImageBuffer; // [OUT] Output image buffer
|
||
nImageLen; // [OUT] Output image size
|
||
nBufferSize; // [IN] Output buffer size provided
|
||
enImageType; // [IN] Output image format
|
||
nJpgQuality; // [IN] Encoding quality, (50-99]
|
||
nReserved[4];
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SaveImageEx(IN OUT MV_SAVE_IMAGE_PARAM_EX* pSaveParam);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 强制IP（该接口已弃用，建议改用 MV_GIGE_ForceIpEx接口）
|
||
* @param handle [IN] 设备句柄
|
||
* @param nIP [IN] 设置的IP
|
||
* @return 见返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Force IP (This interface is abandoned, it is recommended to use the MV_GIGE_ForceIpEx)
|
||
* @param handle [IN] Handle
|
||
* @param nIP [IN] IP to set
|
||
* @return Refer to error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_ForceIp(IN void* handle, unsigned int nIP);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 注册事件回调（该接口已弃用，建议改用 MV_CC_RegisterEventCallBackEx接口）
|
||
* @param handle [IN] 设备句柄
|
||
* @param cbEvent [IN] 事件回调函数指针
|
||
* @param pUser [IN] 用户自定义变量
|
||
* @return 见返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Register event callback (this interface has been deprecated and is recommended to be converted to the MV_CC_RegisterEventCallBackEx interface)
|
||
* @param handle [IN] Handle
|
||
* @param cbEvent [IN] event callback pointer
|
||
* @param pUser [IN] User defined value
|
||
* @return Refer to error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_RegisterEventCallBack(void* handle,
|
||
void(__stdcall* cbEvent)(unsigned int nExternalEventId, void* pUser),
|
||
void* pUser);
|
||
|
||
|
||
/************************************************************************/
|
||
/* 相机参数获取和设置，此模块的所有接口，将逐步废弃，建议用万能接口代替 */
|
||
/* Get and set camara parameters, all interfaces of this module will be replaced by general interface*/
|
||
/************************************************************************/
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取图像宽度
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机宽度的信息结构体指针
|
||
* 返回的pstValue结构体的意义
|
||
* - unsigned int nCurValue; // 代表相机当前的宽度值
|
||
* - unsigned int nMax; // 表示相机允许的最大可设置的宽度值
|
||
* - unsigned int nMin; // 表示相机允许的最小可设置的宽度值
|
||
* - unsigned int nInc; // 表示相机设置的宽度增量必须是nInc的倍数，否则无效
|
||
* @return 成功,返回#MV_OK,并获得相应参数信息的结构体, 失败, 返回错误码
|
||
* @remarks 其他整型结构体参数的接口可参照此接口
|
||
|
||
* @~english
|
||
* @brief Get image width
|
||
* @param handle [IN] Camera Handle
|
||
* @param pstValue [IN][OUT] Returns the information structure pointer about the camera's width for the caller
|
||
* The meaning of returns pstValue structure
|
||
* - unsigned int nCurValue; // Represents the current width value of the camera
|
||
* - unsigned int nMax; // Indicates the maximum settable width value allowed by the camera
|
||
* - unsigned int nMin; // Indicates the minimum settable width value allowed by the camera
|
||
* - unsigned int nInc; // Indicates that the width increment set by the camera must be a multiple of nInc, otherwise it is invalid
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* @remarks Other Integer structure parameters interface can refer to this interface
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetWidth(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置图像宽度
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的相机宽度的值,注意此宽度值必须是MV_CC_GetWidth接口返回的pstValue中的nInc的倍数才能设置成功
|
||
* @return 成功,返回#MV_OK,并且相机宽度将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set image width
|
||
* @param handle [IN] Camera Handle
|
||
* @param nValue [IN] To set the value of the camera width, note that the width value must be a multiple of nInc in the pstValue returned by the MV_CC_GetWidth interface
|
||
* @return Success, return #MV_OK, and the camera width will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetWidth(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取图像高度
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机高度的信息结构体指针
|
||
* @return 成功,返回#MV_OK,并将高度信息返回到结构体中，失败,返回错误码
|
||
* @remarks 可参照接口#MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get image height
|
||
* @param handle [IN] Camera handle
|
||
* @param pstValue [IN][OUT] Return pointer of information structure related to camera height to user
|
||
* @return Success, return #MV_OK, and return height information to the structure. Failure, return error code
|
||
* @remarks Refer to #MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetHeight(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置图像高度
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的相机宽度的值,注意此宽度值必须是MV_CC_GetWidth接口返回的pstValue中的nInc的倍数才能设置成功
|
||
* @return 成功,返回#MV_OK,并且相机高度将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set image height
|
||
* @param handle [IN] Camera Handle
|
||
* @param nValue [IN] Camera height value to set, note that this value must be times of nInc of pstValue returned by MV_CC_GetWidth
|
||
* @return Success, return #MV_OK, and the camera height will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetHeight(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取图像X偏移
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机X偏移的信息结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口#MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get image X offset
|
||
* @param handle [IN] Camera Handle
|
||
* @param pstValue [IN][OUT] Return pointer of information structure related to camera X offset to user
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to #MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetAOIoffsetX(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置图像AOI偏移
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的相机AOI的值
|
||
* @return 成功,返回#MV_OK,并且相机AOI偏移将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set image X offset
|
||
* @param handle [IN] Camera Handle
|
||
* @param nValue [IN] Camera X offset value to set
|
||
* @return Success, return #MV_OK, and the camera X offset will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetAOIoffsetX(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取图像Y偏移
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机Y偏移的信息结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口#MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get image Y offset
|
||
* @param handle [IN] Camera Handle
|
||
* @param pstValue [IN][OUT] Return pointer of information structure related to camera Y offset to user
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to #MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetAOIoffsetY(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置图像AOI偏移
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的相机AOI的值
|
||
* @return 成功,返回#MV_OK,并且相机AOI偏移将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set image Y offset
|
||
* @param handle [IN] Camera Handle
|
||
* @param nValue [IN] Camera Y offset value to set
|
||
* @return Success, return #MV_OK, and the camera Y offset will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetAOIoffsetY(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取曝光下限
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机曝光值下限结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口#MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get exposure lower limit
|
||
* @param handle [IN] Camera Handle
|
||
* @param pstValue [IN][OUT] Return pointer of information structure related to camera exposure lower to user
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to #MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetAutoExposureTimeLower(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置曝光值下限
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的曝光值下限
|
||
* @return 成功,返回#MV_OK,并且相机曝光下限将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set exposure lower limit
|
||
* @param handle [IN] Camera Handle
|
||
* @param nValue [IN] Exposure lower to set
|
||
* @return Success, return #MV_OK, and the camera exposure time lower limit value will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetAutoExposureTimeLower(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取曝光上限
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机曝光值上限结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口#MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get exposure upper limit
|
||
* @param handle [IN] Camera Handle
|
||
* @param pstValue [IN][OUT] Return pointer of information structure related to camera exposure upper to user
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to #MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetAutoExposureTimeUpper(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置曝光值上限
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的曝光值上限
|
||
* @return 成功,返回#MV_OK,并且相机曝光上限将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set exposure upper limit
|
||
* @param handle [IN] Camera Handle
|
||
* @param nValue [IN] Exposure upper to set
|
||
* @return Success, return #MV_OK, and the camera exposure time upper limit value will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetAutoExposureTimeUpper(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取亮度值
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机亮度结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口#MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get brightness
|
||
* @param handle [IN] Camera Handle
|
||
* @param pstValue [IN][OUT] Return pointer of information structure related to camera brightness to user
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to #MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetBrightness(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置亮度值
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的亮度值
|
||
* @return 成功,返回#MV_OK,并且相机亮度将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set brightness
|
||
* @param handle [IN] Camera Handle
|
||
* @param nValue [IN] Brightness upper to set
|
||
* @return Success, return #MV_OK, and the camera brightness value will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetBrightness(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取帧率
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机帧率的信息结构体指针
|
||
* 返回的pstValue结构体的意义
|
||
* - float fCurValue; // 表示相机当前的帧率
|
||
* - float fMax; // 表示相机允许设置的最大帧率
|
||
* - float fMin; // 表示相机允许设置的最小帧率
|
||
* @return 成功,返回#MV_OK,并获得相应参数信息的结构体, 失败, 返回错误码
|
||
* @remarks 其他浮点型结构体参数的接口可参照此接口
|
||
|
||
* @~english
|
||
* @brief Get Frame Rate
|
||
* @param handle [IN] Camera Handle
|
||
* @param pstValue [IN][OUT] Return pointer of information structure related to camera frame rate to user
|
||
* The meaning of returns pstValue structure
|
||
* - float fCurValue; // Indicates the current frame rate of the camera
|
||
* - float fMax; // Indicates the maximum frame rate allowed by the camera
|
||
* - float fMin; // Indicates the minimum frame rate allowed by the camera
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* @remarks Other interface of Float structure parameters can refer to this interface
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetFrameRate(IN void* handle, IN OUT MVCC_FLOATVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置帧率
|
||
* @param handle [IN] 相机句柄
|
||
* @param fValue [IN] 想要设置的相机帧率
|
||
* @return 成功,返回#MV_OK,并且相机帧率将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set frame rate
|
||
* @param handle [IN] Camera Handle
|
||
* @param fValue [IN] Camera frame rate to set
|
||
* @return Success, return #MV_OK, and camera frame rate will be changed to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetFrameRate(IN void* handle, IN const float fValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取增益
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机增益的信息结构体指针
|
||
* 返回的pstValue结构体的意义
|
||
* - float fCurValue; // 表示相机当前的帧率
|
||
* - float fMax; // 表示相机允许设置的最大帧率
|
||
* - float fMin; // 表示相机允许设置的最小帧率
|
||
* @return 成功,返回#MV_OK,并获得相应参数信息的结构体, 失败, 返回错误码
|
||
* @remarks 其他浮点型结构体参数的接口可参照此接口
|
||
|
||
* @~english
|
||
* @brief Get Gain
|
||
* @param handle [IN] Camera Handle
|
||
* @param pstValue [IN][OUT] Return pointer of information structure related to gain to user
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* - float fCurValue; // Camera current gain
|
||
* - float fMax; // The maximum gain camera allowed
|
||
* - float fMin; // The minimum gain camera allowed
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* @remarks Other interface of Float structure parameters can refer to this interface
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetGain(IN void* handle, IN OUT MVCC_FLOATVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置帧率
|
||
* @param handle [IN] 相机句柄
|
||
* @param fValue [IN] 想要设置的相机帧率
|
||
* @return 成功,返回#MV_OK,并且相机帧率将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set Gain
|
||
* @param handle [IN] Camera Handle
|
||
* @param fValue [IN] Gain value to set
|
||
* @return Success, return #MV_OK, and the camera gain value will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetGain(IN void* handle, IN const float fValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取曝光时间
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机曝光时间的信息结构体指针
|
||
* 返回的pstValue结构体的意义
|
||
* - float fCurValue; // 表示相机当前的帧率
|
||
* - float fMax; // 表示相机允许设置的最大帧率
|
||
* - float fMin; // 表示相机允许设置的最小帧率
|
||
* @return 成功,返回#MV_OK,并获得相应参数信息的结构体, 失败, 返回错误码
|
||
* @remarks 其他浮点型结构体参数的接口可参照此接口
|
||
|
||
* @~english
|
||
* @brief Get exposure time
|
||
* @param handle [IN] Camera Handle
|
||
* @param pstValue [IN][OUT] Return pointer of information structure related to exposure time to user
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* - float fCurValue; // Camera current exposure time
|
||
* - float fMax; // The maximum exposure time camera allowed
|
||
* - float fMin; // The minimum exposure time camera allowed
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* @remarks Other interface of Float structure parameters can refer to this interface
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetExposureTime(IN void* handle, IN OUT MVCC_FLOATVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置曝光时间
|
||
* @param handle [IN] 相机句柄
|
||
* @param fValue [IN] 想要设置的相机帧率
|
||
* @return 成功,返回#MV_OK,并且相机帧率将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set exposure time
|
||
* @param handle [IN] Camera Handle
|
||
* @param fValue [IN] Exposure time to set
|
||
* @return Success, return #MV_OK, and the camera exposure time value will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetExposureTime(IN void* handle, IN const float fValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取像素格式
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者的有关像素格式的信息结构体指针 \n
|
||
* 返回的pstValue结构体的意义
|
||
* - unsigned int nCurValue; // 相机当前的像素格式，是枚举类型,比如说PixelType_Gvsp_Mono8, 这里获得的是其整型值,具体数值参照PixelType.h的MvGvspPixelType枚举类型
|
||
* - unsigned int nSupportedNum; // 相机支持的像素格式的个数
|
||
* - unsigned int nSupportValue[MV_MAX_XML_SYMBOLIC_NUM]; // 相机所有支持的像素格式对应的整型值列表，后面要设置像素格式时，参数必须是这个数组中的一种，否则无效
|
||
* @return 成功,返回#MV_OK,并获得相应参数信息的结构体, 失败, 返回错误码
|
||
* @remarks 其他枚举类型参数接口可参照此接口，有关相应参数的枚举类型对应的整型值请查找PixelType.h 和 CameraParams.h中相应的定义
|
||
|
||
* @~english
|
||
* @brief Get Pixel Format
|
||
* @param handle [IN] Camera Handle
|
||
* @param pstValue [IN][OUT] Returns the information structure pointer about pixel format for the caller \n
|
||
* The meaning of returns pstValue structure
|
||
* - unsigned int nCurValue; // The current pixel format of the camera, is the enumeration type, such as #PixelType_Gvsp_Mono8, here is the integer value, the specific value please refer to MvGvspPixelType enumeration type in PixelType.h
|
||
* - unsigned int nSupportedNum; // Number of pixel formats supported by the camera
|
||
* - unsigned int nSupportValue[MV_MAX_XML_SYMBOLIC_NUM]; // The integer values list correspond to all supported pixel formats of the camera, followed by when set the pixel format, the parameter must be one of this list, otherwise invalid
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* @remarks Other interface of Enumeration structure parameters can refer to this interface, look for the corresponding definition in PixelType.h and CameraParams.h for the integer values of the enum type parameter
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetPixelFormat(IN void* handle, IN OUT MVCC_ENUMVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置像素格式
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 要设置的像素格式对应的整型值，调用此接口时可以直接填写枚举值，如#MV_CC_SetPixelFormat(m_handle, #PixelType_Gvsp_RGB8_Packed);
|
||
* @return 成功,返回#MV_OK,并且相机像素格式将会更改为相应值，失败,返回错误码
|
||
* @remarks 要设置的枚举类型必须是Get接口返回的nSupportValue[MV_MAX_XML_SYMBOLIC_NUM]中的一种，否则会失败
|
||
|
||
* @~english
|
||
* @brief Set Pixel Format
|
||
* @param handle [IN] Camera Handle
|
||
* @param nValue [IN] The corresponding integer value for pixel format to be set, when calling this interface can be directly filled in enumeration values, such as MV_CC_SetPixelFormat(m_handle, PixelType_Gvsp_RGB8_Packed);
|
||
* @return Success, return #MV_OK, and the camera pixel format will change to the corresponding value. Failure, return error code
|
||
* @remarks Other interface of Enumeration structure parameters can refer to this interface, the enumeration type to be set must be one of the nSupportValue [#MV_MAX_XML_SYMBOLIC_NUM] returned by the Get interface, otherwise it will fail
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetPixelFormat(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取采集模式
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者的有关采集模式的信息结构体指针
|
||
* @return 成功,返回#MV_OK,并获得相应参数信息的结构体, 失败, 返回错误码
|
||
* @remarks 可参照接口#MV_CC_GetPixelFormat，参考 CameraParams.h 中的#MV_CAM_ACQUISITION_MODE 定义
|
||
|
||
* @~english
|
||
* @brief Get acquisition mode
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of acquisition mode
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* @remarks Refer to #MV_CC_GetPixelFormat and definition of #MV_CAM_ACQUISITION_MODE in CameraParams.h
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetAcquisitionMode(IN void* handle, IN OUT MVCC_ENUMVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置像素格式
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 要设置的采集模式对应的整型值
|
||
* @return 成功,返回#MV_OK,并且相机采集模式将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set acquisition mode
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Integer value to set corresponding to acquisition mode
|
||
* @return Success, return #MV_OK, and the camera acquisition mode will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetAcquisitionMode(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取增益模式
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者的有关增益模式的信息结构体指针
|
||
* @return 成功,返回#MV_OK,并获得相应参数信息的结构体, 失败, 返回错误码
|
||
* @remarks 可参照接口#MV_CC_GetPixelFormat，参考 CameraParams.h 中的 MV_CAM_GAIN_MODE 定义
|
||
|
||
* @~english
|
||
* @brief Get gain mode
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of gain mode
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* @remarks Refer to #MV_CC_GetPixelFormat and definition of #MV_CAM_GAIN_MODE in CameraParams.h
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetGainMode(IN void* handle, IN OUT MVCC_ENUMVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置增益模式
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 要设置的增益模式对应的整型值
|
||
* @return 成功,返回#MV_OK,并且相机增益模式将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set gain mode
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Integer value to set corresponding to gain mode
|
||
* @return Success, return #MV_OK, and the camera gain mode will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetGainMode(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取自动曝光模式
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者的有关自动曝光模式的信息结构体指针
|
||
* @return 成功,返回#MV_OK,并获得相应参数信息的结构体, 失败, 返回错误码
|
||
* @remarks 可参照接口#MV_CC_GetPixelFormat，参考 CameraParams.h 中的#MV_CAM_EXPOSURE_AUTO_MODE 定义
|
||
|
||
* @~english
|
||
* @brief Get auto exposure mode
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of auto exposure mode
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* @remarks Refer to #MV_CC_GetPixelFormat and definition of #MV_CAM_EXPOSURE_AUTO_MODE in CameraParams.h
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetExposureAutoMode(IN void* handle, IN OUT MVCC_ENUMVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置自动曝光模式
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 要设置的自动曝光模式对应的整型值
|
||
* @return 成功,返回#MV_OK,并且相机自动曝光模式将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set auto exposure mode
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Integer value to set corresponding to auto exposure mode
|
||
* @return Success, return #MV_OK, and the camera auto exposure mode will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetExposureAutoMode(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取触发模式
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者的有关触发模式的信息结构体指针
|
||
* @return 成功,返回#MV_OK,并获得相应参数信息的结构体, 失败, 返回错误码
|
||
* @remarks 可参照接口#MV_CC_GetPixelFormat，参考 CameraParams.h 中的#MV_CAM_TRIGGER_MODE 定义
|
||
|
||
* @~english
|
||
* @brief Get trigger mode
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of trigger mode
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* @remarks Refer to #MV_CC_GetPixelFormat and definition of #MV_CAM_TRIGGER_MODE in CameraParams.h
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetTriggerMode(IN void* handle, IN OUT MVCC_ENUMVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置触发模式
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 要设置的触发模式对应的整型值
|
||
* @return 成功,返回#MV_OK,并且相机触发模式将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set trigger mode
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Integer value to set corresponding to trigger mode
|
||
* @return Success, return #MV_OK, and the camera trigger mode will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetTriggerMode(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取触发延时
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机触发延时的信息结构体指针
|
||
* @return 成功,返回#MV_OK,并获得相应参数信息的结构体, 失败, 返回错误码
|
||
* @remarks 可参照接口MV_CC_GetFrameRate
|
||
|
||
* @~english
|
||
* @brief Get tigger delay
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of trigger delay
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetFrameRate
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetTriggerDelay(IN void* handle, IN OUT MVCC_FLOATVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置触发延时
|
||
* @param handle [IN] 相机句柄
|
||
* @param fValue [IN] 想要设置的相机触发延时
|
||
* @return 成功,返回#MV_OK,并且相机触发延时将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set tigger delay
|
||
* @param handle [IN] Handle
|
||
* @param fValue [IN] Trigger delay to set
|
||
* @return Success, return #MV_OK, and the camera trigger delay will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetTriggerDelay(IN void* handle, IN const float fValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取触发源
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者的有关触发源的信息结构体指针
|
||
* @return 成功,返回#MV_OK,并获得相应参数信息的结构体, 失败, 返回错误码
|
||
* @remarks 可参照接口MV_CC_GetPixelFormat，参考 CameraParams.h 中的 MV_CAM_TRIGGER_SOURCE 定义
|
||
|
||
* @~english
|
||
* @brief Get trigger source
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of trigger source
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetPixelFormat and definition of MV_CAM_TRIGGER_SOURCE in CameraParams.h
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetTriggerSource(IN void* handle, IN OUT MVCC_ENUMVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置触发源
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 要设置的触发源对应的整型值
|
||
* @return 成功,返回#MV_OK,并且相机触发源将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set trigger source
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Integer value to set corresponding to trigger source
|
||
* @return Success, return #MV_OK, and the camera trigger source will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetTriggerSource(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 软触发一次（接口仅在已选择的触发源为软件触发时有效）
|
||
* @param handle [IN] 相机句柄
|
||
* @return 成功,返回#MV_OK, 失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Execute software trigger once (this interface only valid when the trigger source is set to software)
|
||
* @param handle [IN] Handle
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_TriggerSoftwareExecute(IN void* handle);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取Gamma类型
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者的有关Gamma类型的信息结构体指针
|
||
* @return 成功,返回#MV_OK,并获得相应参数信息的结构体, 失败, 返回错误码
|
||
* @remarks 可参照接口MV_CC_GetPixelFormat，参考 CameraParams.h 中的 MV_CAM_GAMMA_SELECTOR 定义
|
||
|
||
* @~english
|
||
* @brief Get Gamma mode
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of gamma mode
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetPixelFormat and definition of MV_CAM_GAMMA_SELECTOR in CameraParams.h
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetGammaSelector(IN void* handle, IN OUT MVCC_ENUMVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置Gamma类型
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 要设置的Gamma类型对应的整型值
|
||
* @return 成功,返回#MV_OK,并且相机Gamma类型将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set Gamma mode
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Integer value to set corresponding to gamma mode
|
||
* @return Success, return #MV_OK, and the camera gamma mode will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetGammaSelector(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取Gamma值
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机Gamma值的信息结构体指针
|
||
* @return 成功,返回#MV_OK,并获得相应参数信息的结构体, 失败, 返回错误码
|
||
* @remarks 可参照接口MV_CC_GetExposureTime
|
||
|
||
* @~english
|
||
* @brief Get Gamma value
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of gamma value
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetFrameRate
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetGamma(IN void* handle, IN OUT MVCC_FLOATVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置Gamma值
|
||
* @param handle [IN] 相机句柄
|
||
* @param fValue [IN] 想要设置的相机Gamma值
|
||
* @return 成功,返回#MV_OK,并且相机Gamma值将会更改为相应值，失败,返回错误码
|
||
|
||
* @~english
|
||
* @brief Set Gamma value
|
||
* @param handle [IN] Handle
|
||
* @param fValue [IN] Gamma value to set
|
||
* @return Success, return #MV_OK, and the camera gamma value will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetGamma(IN void* handle, IN const float fValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取锐度
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机锐度结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get sharpness
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of sharpness
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetSharpness(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置锐度
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的锐度
|
||
* @return 成功,返回#MV_OK,并且相机锐度将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set sharpness
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Sharpness to set
|
||
* @return Success, return #MV_OK, and the camera sharpness will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetSharpness(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取灰度
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机灰度结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get Hue
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of Hue
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetHue(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置灰度
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的灰度
|
||
* @return 成功,返回#MV_OK,并且相机灰度将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set Hue
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Hue to set
|
||
* @return Success, return #MV_OK, and the camera Hue will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetHue(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取饱和度
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机饱和度结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get Saturation
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of Saturation
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetSaturation(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置饱和度
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的饱和度
|
||
* @return 成功,返回#MV_OK,并且相机饱和度将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set Saturation
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Saturation to set
|
||
* @return Success, return #MV_OK, and the camera Saturation will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetSaturation(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取自动白平衡
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者的有关自动白平衡的信息结构体指针
|
||
* @return 成功,返回#MV_OK,并获得相应参数信息的结构体, 失败, 返回错误码
|
||
* @remarks 可参照接口MV_CC_GetPixelFormat，参考 CameraParams.h 中的 MV_CAM_BALANCEWHITE_AUTO 定义
|
||
|
||
|
||
* @~english
|
||
* @brief Get Auto white balance
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of auto white balance
|
||
* @return Success, return #MV_OK, and get the structure of the corresponding parameters. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetPixelFormat and definition of MV_CAM_BALANCEWHITE_AUTO in CameraParams.h
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetBalanceWhiteAuto(IN void* handle, IN OUT MVCC_ENUMVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置自动白平衡
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 要设置的自动白平衡对应的整型值
|
||
* @return 成功,返回#MV_OK,并且相机自动白平衡将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set Auto white balance
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Integer value to set corresponding to auto white balance
|
||
* @return Success, return #MV_OK, and the camera auto white balance will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetBalanceWhiteAuto(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取白平衡 红
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机白平衡 红结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get white balance red
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of white balance red
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetBalanceRatioRed(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置白平衡 红
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的白平衡 红
|
||
* @return 成功,返回#MV_OK,并且相机白平衡 红将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set white balance red
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] White balance red to set
|
||
* @return Success, return #MV_OK, and the camera white balance red will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetBalanceRatioRed(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取白平衡 绿
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机白平衡 绿结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get white balance green
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of white balance green
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetBalanceRatioGreen(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置白平衡 绿
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的白平衡 绿
|
||
* @return 成功,返回#MV_OK,并且相机白平衡 绿将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set white balance green
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] White balance green to set
|
||
* @return Success, return #MV_OK, and the camera white balance green will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetBalanceRatioGreen(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取白平衡 蓝
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机白平衡 蓝结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get white balance blue
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of white balance blue
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetBalanceRatioBlue(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置白平衡 蓝
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的白平衡 蓝
|
||
* @return 成功,返回#MV_OK,并且相机白平衡 蓝将会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set white balance blue
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] White balance blue to set
|
||
* @return Success, return #MV_OK, and the camera white balance blue will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetBalanceRatioBlue(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取水印信息内包含的信息类型
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机水印信息内包含的信息类型结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get information type included by frame stamp
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of information type included by frame stamp
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetFrameSpecInfoAbility(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置水印信息内包含的信息类型
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的水印信息内包含的信息类型
|
||
* @return 成功,返回#MV_OK,并且相机水印信息内包含的信息类型会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set information type included by frame stamp
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Information type included by frame stamp to set
|
||
* @return Success, return #MV_OK, and the camera information type included by frame stamp will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetFrameSpecInfoAbility(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取设备自定义名字
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机名字结构体指针
|
||
* @return 成功,返回#MV_OK,并且获取到相机的自定义名字，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Get device user defined name
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of device name
|
||
* @return Success, return #MV_OK, and get the camera user defined name. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetDeviceUserID(IN void* handle, IN OUT MVCC_STRINGVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置设备自定义名字
|
||
* @param handle [IN] 相机句柄
|
||
* @param chValue [IN] 设备名字
|
||
* @return 成功,返回#MV_OK,并且设置设备自定义名字，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set device user defined name
|
||
* @param handle [IN] Handle
|
||
* @param chValue [IN] Device name
|
||
* @return Success, return #MV_OK, and set the camera user defined name. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetDeviceUserID(IN void* handle, IN const char* chValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取一次触发的帧数
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机一次触发的帧数结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get frame number trigger by once
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of frame number trigger by once
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetBurstFrameCount(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置一次触发的帧数
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的一次触发的帧数
|
||
* @return 成功,返回#MV_OK,并且相机一次触发的帧数会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set frame number trigger by once
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Frame number trigger by once to set
|
||
* @return Success, return #MV_OK, and the camera frame number trigger by once will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetBurstFrameCount(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取行频
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机行频结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get line rate
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of line rate
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetAcquisitionLineRate(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置行频
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的行频
|
||
* @return 成功,返回#MV_OK,并且相机行频会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set line rate
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Line rate to set
|
||
* @return Success, return #MV_OK, and the camera line rate will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetAcquisitionLineRate(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取心跳信息
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机心跳信息结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get heartbeat information
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of heartbeat information
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_GetHeartBeatTimeout(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置心跳信息
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的心跳信息
|
||
* @return 成功,返回#MV_OK,并且相机心跳信息会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set heartbeat information
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Heartbeat information to set
|
||
* @return Success, return #MV_OK, and the camera heartbeat information will change to the corresponding value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CC_SetHeartBeatTimeout(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取网络包大小
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机网络包大小结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get network packet size
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of network packet size
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_GetGevSCPSPacketSize(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置网络包大小
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的网络包大小
|
||
* @return 成功,返回#MV_OK,并且相机网络包大小会更改为相应值，失败,返回错误码
|
||
|
||
* @~english
|
||
* @brief Set network packet size
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Packet size to set
|
||
* @return Success, return #MV_OK, and change packet size to setting value. Failure, return error code
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_SetGevSCPSPacketSize(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取网络包发送间隔
|
||
* @param handle [IN] 相机句柄
|
||
* @param pstValue [IN][OUT] 返回给调用者有关相机网络包发送间隔结构体指针
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 可参照接口MV_CC_GetWidth
|
||
|
||
* @~english
|
||
* @brief Get network packet sending delay
|
||
* @param handle [IN] Handle
|
||
* @param pstValue [IN][OUT] Structure pointer of network packet sending delay
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks Refer to MV_CC_GetWidth
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_GetGevSCPD(IN void* handle, IN OUT MVCC_INTVALUE* pstValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置网络包发送间隔
|
||
* @param handle [IN] 相机句柄
|
||
* @param nValue [IN] 想要设置的网络包发送间隔
|
||
* @return 成功,返回#MV_OK,并且相机网络包发送间隔会更改为相应值，失败,返回错误码
|
||
|
||
* @~english
|
||
* @brief Set network packet sending delay
|
||
* @param handle [IN] Handle
|
||
* @param nValue [IN] Packet delay to set
|
||
* @return Success, return #MV_OK, and change packet delay to setting value. Failure, return error code
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_SetGevSCPD(IN void* handle, IN const unsigned int nValue);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取接收端IP地址，0xa9fe0102 表示 169.254.1.2
|
||
* @param handle [IN] 相机句柄
|
||
* @param pnIP [IN][OUT] 返回给调用者接收端IP地址
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Get receiver IP address, 0xa9fe0102 indicates 169.254.1.2
|
||
* @param handle [IN] Handle
|
||
* @param pnIP [IN][OUT] Receiver IP address
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_GetGevSCDA(IN void* handle, unsigned int* pnIP);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置接收端IP地址
|
||
* @param handle [IN] 相机句柄
|
||
* unsigned int nIP [IN] 想要设置的接收端IP地址
|
||
* @return 成功,返回#MV_OK,并且相机接收端IP地址会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set receiver IP address
|
||
* @param handle [IN] Handel
|
||
* unsigned int nIP [IN] Receiver IP address to set
|
||
* @return Success, return #MV_OK, and change receiver IP address to setting value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_SetGevSCDA(IN void* handle, unsigned int nIP);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取发送端的端口号
|
||
* @param handle [IN] 相机句柄
|
||
* @param pnPort [IN][OUT] 返回给调用者发送端的端口号
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Get transmitter port number
|
||
* @param handle [IN] Handle
|
||
* @param pnPort [IN][OUT] Transmitter port number
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_GetGevSCSP(IN void* handle, unsigned int* pnPort);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置发送端的端口号
|
||
* @param handle [IN] 相机句柄
|
||
* @param nPort [IN] 想要设置的发送端的端口号
|
||
* @return 成功,返回#MV_OK,并且相机发送端的端口号会更改为相应值，失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Set transmitter port number
|
||
* @param handle [IN] Handle
|
||
* @param nPort [IN] Transmitter port number to set
|
||
* @return Success, return #MV_OK, and change transmitter port number to setting value. Failure, return error code
|
||
* @remarks
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_GIGE_SetGevSCSP(IN void* handle, unsigned int nPort);
|
||
|
||
|
||
/************************************************************************/
|
||
/* CameraLink 设备独有的接口,Linux 平台不支持 */
|
||
/* APIs only support CameraLink device, not supported on Linux */
|
||
/************************************************************************/
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置设备波特率
|
||
* @param handle [IN] 设备句柄
|
||
* @param nBaudrate [IN] 设置的波特率值，数值参考CameraParams.h中宏定义，如#define MV_CAML_BAUDRATE_9600 0x00000001
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 该接口接口支持在设备未连接时调用。
|
||
|
||
* @~english
|
||
* @brief Set device bauderate using one of the CL_BAUDRATE_XXXX value
|
||
* @param handle [IN] Device handle
|
||
* @param nBaudrate [IN] baud rate to set. Refer to the CameraParams.h for parameter definitions, for example, #define MV_CAML_BAUDRATE_9600 0x00000001
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks This API is supported only by CameraLink device.\n
|
||
This API supports calls when devices are not connected.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CAML_SetDeviceBauderate(IN void* handle, unsigned int nBaudrate);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取设备波特率
|
||
* @param handle [IN] 设备句柄
|
||
* @param pnCurrentBaudrate [OUT] 波特率信息指针，数值参考CameraParams.h中宏定义，如#define MV_CAML_BAUDRATE_9600 0x00000001
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 该接口接口支持在设备未连接时调用。
|
||
|
||
* @~english
|
||
* @brief Returns the current device bauderate, using one of the CL_BAUDRATE_XXXX value
|
||
* @param handle [IN] Device handle
|
||
* @param pnCurrentBaudrate [OUT] Return pointer of baud rate to user. Refer to the CameraParams.h for parameter definitions, for example, #define MV_CAML_BAUDRATE_9600 0x00000001
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks This API is supported only by CameraLink device.\n
|
||
This API supports calls when devices are not connected.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CAML_GetDeviceBauderate(IN void* handle, unsigned int* pnCurrentBaudrate);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取设备与主机间连接支持的波特率
|
||
* @param handle [IN] 设备句柄
|
||
* @param pnBaudrateAblity [OUT] 支持的波特率信息的指针。所支持波特率的或运算结果，单个数值参考CameraParams.h中宏定义，如#define MV_CAML_BAUDRATE_9600 0x00000001
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks 该接口接口支持在设备未连接时调用。
|
||
|
||
* @~english
|
||
* @brief Returns supported bauderates of the combined device and host interface
|
||
* @param handle [IN] Device handle
|
||
* @param pnBaudrateAblity [OUT] Return pointer of the supported bauderates to user. 'OR' operation results of the supported bauderates. Refer to the CameraParams.h for single value definitions, for example, #define MV_CAML_BAUDRATE_9600 0x00000001
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @remarks This API is supported only by CameraLink device.\n
|
||
This API supports calls when devices are not connected.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CAML_GetSupportBauderates(IN void* handle, unsigned int* pnBaudrateAblity);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置串口操作等待时长
|
||
* @param handle [IN] 设备句柄
|
||
* @param nMillisec [IN] 串口操作的等待时长, ms
|
||
* @return 成功,返回#MV_OK,失败,返回错误码
|
||
* @remarks
|
||
|
||
* @~english
|
||
* @brief Sets the timeout for operations on the serial port
|
||
* @param handle [IN] Device handle
|
||
* @param nMillisec [IN] Timeout in [ms] for operations on the serial port.
|
||
* @return Success, return #MV_OK. Failure, return error code
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_CAML_SetGenCPTimeOut(IN void* handle, unsigned int nMillisec);
|
||
|
||
/************************************************************************/
|
||
/* U3V 设备独有的接口 */
|
||
/************************************************************************/
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置U3V的传输包大小
|
||
* @param handle [IN] 设备句柄
|
||
* @param nTransferSize [IN] 传输的包大小, Byte，默认为1M，rang：>=0x10000
|
||
* @return 成功,返回MV_OK,失败,返回错误码
|
||
* @remarks 增加传输包大小可以适当降低取流时的CPU占用率。但不同的PC和不同USB扩展卡存在不同的兼容性，如果该参数设置过大可能会出现取不到图像的风险。
|
||
|
||
* @~english
|
||
* @brief Set transfer size of U3V device
|
||
* @param handle [IN] Device handle
|
||
* @param nTransferSize [IN] Transfer size，Byte，default：1M，rang：>=0x10000
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks Increasing the transmission packet size can reduce the CPU utilization at the time of fetching. However, different PCS and different USB extension CARDS have different compatibility, and if this parameter is set too large, there may be the risk of not getting the image.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_USB_SetTransferSize(IN void* handle, unsigned int nTransferSize);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取U3V的传输包大小
|
||
* @param handle [IN] 设备句柄
|
||
* @param pnTransferSize [OUT] 传输的包大小指针, Byte
|
||
* @return 成功,返回MV_OK,失败,返回错误码
|
||
* @remarks 该接口用于获取当前的U3V传输包大小，默认1M。
|
||
|
||
* @~english
|
||
* @brief Get transfer size of U3V device
|
||
* @param handle [IN] Device handle
|
||
* @param pnTransferSize [OUT] Transfer size，Byte
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks This interface is used to get the current U3V transfer packet size, default 1M.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_USB_GetTransferSize(IN void* handle, unsigned int* pnTransferSize);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 设置U3V的传输通道个数
|
||
* @param handle [IN] 设备句柄
|
||
* @param nTransferWays [IN] 传输通道个数，范围：1-10
|
||
* @return 成功,返回MV_OK,失败,返回错误码
|
||
* @remarks 用户可以根据PC的性能、设备出图帧率、图像大小和内存使用率等因素对该参数进行调节。但不同的PC和不同的USB扩展卡存在不同的兼容性。
|
||
|
||
* @~english
|
||
* @brief Set transfer ways of U3V device
|
||
* @param handle [IN] Device handle
|
||
* @param nTransferWays [IN] Transfer ways，rang：1-10
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks Users can adjust this parameter according to PC performance, camera image frame rate, image size, memory utilization and other factors. But different PCS and different USB expansion CARDS have different compatibility.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_USB_SetTransferWays(IN void* handle, unsigned int nTransferWays);
|
||
|
||
/********************************************************************//**
|
||
* @~chinese
|
||
* @brief 获取U3V的传输通道个数
|
||
* @param handle [IN] 设备句柄
|
||
* @param pnTransferWays [OUT] 传输通道个数指针
|
||
* @return 成功,返回MV_OK,失败,返回错误码
|
||
* @remarks 该接口用于获取当前的U3V异步取流节点个数，2000W设备的MONO8默认为3个，YUV为默认2个，RGB为默认1个，其它情况默认8个节点。
|
||
|
||
* @~english
|
||
* @brief Get transfer ways of U3V device
|
||
* @param handle [IN] Device handle
|
||
* @param pnTransferWays [OUT] Transfer ways
|
||
* @return Success, return MV_OK. Failure, return error code
|
||
* @remarks This interface is used to get the current number of U3V asynchronous feed nodes. For 2000W camera, MONO8 defaults to 3, YUV defaults to 2, RGB defaults to 1, and other cases default to 8 nodes.
|
||
************************************************************************/
|
||
MV_CAMCTRL_API int __stdcall MV_USB_GetTransferWays(IN void* handle, unsigned int* pnTransferWays);
|
||
|
||
#ifdef __cplusplus
|
||
}
|
||
#endif
|
||
|
||
#endif //_MV_CAMERA_CTRL_H_
|