Reason: APIs of getting and setting parameters are replaced by newly developed ones; less effective APIs are replaced by more effective ones; some APIs are not often used in actual development. More...

Functions
MV_CAMCTRL_API int __stdcall	MV_CC_GetImageInfo (IN void handle, IN OUT MV_IMAGE_BASIC_INFO pstInfo)
	Get basic information of image. More...

MV_CAMCTRL_API void *__stdcall	MV_CC_GetTlProxy (IN void *handle)
	Get GenICam proxy. More...

MV_CAMCTRL_API int __stdcall	MV_XML_GetRootNode (IN void handle, IN OUT MV_XML_NODE_FEATURE pstNode)
	Get root node. More...

MV_CAMCTRL_API int __stdcall	MV_XML_GetChildren (IN void handle, IN MV_XML_NODE_FEATURE pstNode, IN OUT MV_XML_NODES_LIST *pstNodesList)
	Get all children node of specific node from xml, root node is Root. More...

MV_CAMCTRL_API int __stdcall	MV_XML_GetNodeFeature (IN void handle, IN MV_XML_NODE_FEATURE pstNode, IN OUT void *pstFeature)
	Get current node feature. More...

MV_CAMCTRL_API int __stdcall	MV_XML_UpdateNodeFeature (IN void handle, IN enum MV_XML_InterfaceType enType, IN void pstFeature)
	Update node. More...

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)
	Register update callback. More...

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)
	Get one frame of image data. It was deprecated, and ::MV_CC_GetOneFrameTimeOut() is recommended. More...

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)
	Get one frame of trunck data. It was deprecated, and ::MV_CC_GetOneFrameTimeOut() is recommended. More...

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)
	Register image data callback. It was deprecated, and MV_CC_RegisterImageCallBackEx() is recommended. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SaveImageEx (IN OUT MV_SAVE_IMAGE_PARAM_EX *pSaveParam)
	Save image, support Bmp and Jpeg. Encoding quality, (50-99]. It was deprecated, and MV_CC_SaveImageEx3() is recommended. More...

MV_CAMCTRL_API int __stdcall	MV_CC_BayerNoiseEstimate (IN void handle, IN OUT MV_CC_BAYER_NOISE_ESTIMATE_PARAM pstNoiseEstimateParam)
	Bayer noise estimation. More...

MV_CAMCTRL_API int __stdcall	MV_CC_BayerSpatialDenoise (IN void handle, IN OUT MV_CC_BAYER_SPATIAL_DENOISE_PARAM pstSpatialDenoiseParam)
	Bayer airspace noise reduction. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetBayerCLUTParam (IN void handle, IN MV_CC_CLUT_PARAM pstCLUTParam)
	Set CLUT param. More...

MV_CAMCTRL_API int __stdcall	MV_CC_ImageSharpen (IN void handle, IN OUT MV_CC_SHARPEN_PARAM pstSharpenParam)
	Image sharpen. More...

MV_CAMCTRL_API int __stdcall	MV_CC_ColorCorrect (IN void handle, IN OUT MV_CC_COLOR_CORRECT_PARAM pstColorCorrectParam)
	Color Correct(include CCM and CLUT) More...

MV_CAMCTRL_API int __stdcall	MV_CC_NoiseEstimate (IN void handle, IN OUT MV_CC_NOISE_ESTIMATE_PARAM pstNoiseEstimateParam)
	Noise Estimate. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SpatialDenoise (IN void handle, IN OUT MV_CC_SPATIAL_DENOISE_PARAM pstSpatialDenoiseParam)
	Spatial Denoise. More...

MV_CAMCTRL_API int __stdcall	MV_CC_LSCCalib (IN void handle, IN OUT MV_CC_LSC_CALIB_PARAM pstLSCCalibParam)
	LSC Calib. More...

MV_CAMCTRL_API int __stdcall	MV_CC_LSCCorrect (IN void handle, IN OUT MV_CC_LSC_CORRECT_PARAM pstLSCCorrectParam)
	LSC Correct. More...

MV_CAMCTRL_API int __stdcall	MV_GIGE_ForceIp (IN void *handle, unsigned int nIP)
	Force IP. MV_GIGE_ForceIpEx() is recommended. More...

MV_CAMCTRL_API int __stdcall	MV_CC_RegisterEventCallBack (void handle, void(__stdcall cbEvent)(unsigned int nExternalEventId, void pUser), void pUser)
	Register event callback. MV_CC_RegisterEventCallBackEx() is recommended. More...

MV_CAMCTRL_API int __stdcall	MV_CC_Display (IN void handle, void hWnd)
	Display one frame image, register display window, automatic display internally. It was deprecated, and MV_CC_DisplayOneFrameEx() is recommneded. More...

MV_CAMCTRL_API int __stdcall	MV_CC_DisplayOneFrame (IN void handle, IN MV_DISPLAY_FRAME_INFO pstDisplayInfo)
	Display one frame image. MV_CC_DisplayOneFrameEx2() is recommended. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetIntValue (IN void handle, IN const char strKey, OUT MVCC_INTVALUE *pIntValue)
	Get Integer value. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetIntValue (IN void handle, IN const char strKey, IN unsigned int nValue)
	Set Integer value. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetWidth (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get image width. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetWidth (IN void *handle, IN const unsigned int nValue)
	Set image width. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetHeight (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get image height. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetHeight (IN void *handle, IN const unsigned int nValue)
	Set image height. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetAOIoffsetX (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get image X-axis offset. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetAOIoffsetX (IN void *handle, IN const unsigned int nValue)
	Set image AOI X-axis offset. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetAOIoffsetY (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get image Y-axis offset. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetAOIoffsetY (IN void *handle, IN const unsigned int nValue)
	Set image AOI Y-axis offset. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetAutoExposureTimeLower (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get exposure lower limit. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetAutoExposureTimeLower (IN void *handle, IN const unsigned int nValue)
	Set exposure lower limit. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetAutoExposureTimeUpper (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get exposure upper limit. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetAutoExposureTimeUpper (IN void *handle, IN const unsigned int nValue)
	Set exposure upper limit. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetBrightness (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get brightness. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetBrightness (IN void *handle, IN const unsigned int nValue)
	Set brightness. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetFrameRate (IN void handle, IN OUT MVCC_FLOATVALUE pstValue)
	Get Frame Rate. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetFrameRate (IN void *handle, IN const float fValue)
	Set frame rate. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetGain (IN void handle, IN OUT MVCC_FLOATVALUE pstValue)
	Get Gain. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetGain (IN void *handle, IN const float fValue)
	Set Gain. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetExposureTime (IN void handle, IN OUT MVCC_FLOATVALUE pstValue)
	Get exposure time. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetExposureTime (IN void *handle, IN const float fValue)
	Set exposure time. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetPixelFormat (IN void handle, IN OUT MVCC_ENUMVALUE pstValue)
	Get Pixel Format. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetPixelFormat (IN void *handle, IN const unsigned int nValue)
	Set Pixel Format. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetAcquisitionMode (IN void handle, IN OUT MVCC_ENUMVALUE pstValue)
	Get acquisition mode. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetAcquisitionMode (IN void *handle, IN const unsigned int nValue)
	Set acquisition mode. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetGainMode (IN void handle, IN OUT MVCC_ENUMVALUE pstValue)
	Get gain mode. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetGainMode (IN void *handle, IN const unsigned int nValue)
	Set gain mode. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetExposureAutoMode (IN void handle, IN OUT MVCC_ENUMVALUE pstValue)
	Get auto exposure mode. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetExposureAutoMode (IN void *handle, IN const unsigned int nValue)
	Set auto exposure mode. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetTriggerMode (IN void handle, IN OUT MVCC_ENUMVALUE pstValue)
	Get trigger mode. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetTriggerMode (IN void *handle, IN const unsigned int nValue)
	Set trigger mode. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetTriggerDelay (IN void handle, IN OUT MVCC_FLOATVALUE pstValue)
	Get tigger delay. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetTriggerDelay (IN void *handle, IN const float fValue)
	Set tigger delay. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetTriggerSource (IN void handle, IN OUT MVCC_ENUMVALUE pstValue)
	Get trigger source. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetTriggerSource (IN void *handle, IN const unsigned int nValue)
	Set trigger source. More...

MV_CAMCTRL_API int __stdcall	MV_CC_TriggerSoftwareExecute (IN void *handle)
	Execute software trigger once (this interface only valid when the trigger source is set to software) More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetGammaSelector (IN void handle, IN OUT MVCC_ENUMVALUE pstValue)
	Get Gamma mode. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetGammaSelector (IN void *handle, IN const unsigned int nValue)
	Set Gamma mode. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetGamma (IN void handle, IN OUT MVCC_FLOATVALUE pstValue)
	Get Gamma value. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetGamma (IN void *handle, IN const float fValue)
	Set Gamma value. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetSharpness (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get sharpness. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetSharpness (IN void *handle, IN const unsigned int nValue)
	Set sharpness. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetHue (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get Hue. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetHue (IN void *handle, IN const unsigned int nValue)
	Set Hue. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetSaturation (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get Saturation. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetSaturation (IN void *handle, IN const unsigned int nValue)
	Set Saturation. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetBalanceWhiteAuto (IN void handle, IN OUT MVCC_ENUMVALUE pstValue)
	Get Auto white balance. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetBalanceWhiteAuto (IN void *handle, IN const unsigned int nValue)
	Set Auto white balance. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetBalanceRatioRed (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get white balance red. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetBalanceRatioRed (IN void *handle, IN const unsigned int nValue)
	Set white balance red. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetBalanceRatioGreen (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get white balance green. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetBalanceRatioGreen (IN void *handle, IN const unsigned int nValue)
	Set white balance green. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetBalanceRatioBlue (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get white balance blue. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetBalanceRatioBlue (IN void *handle, IN const unsigned int nValue)
	Set white balance blue. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetFrameSpecInfoAbility (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get information type included by frame stamp. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetFrameSpecInfoAbility (IN void *handle, IN const unsigned int nValue)
	Set information type included by frame stamp. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetDeviceUserID (IN void handle, IN OUT MVCC_STRINGVALUE pstValue)
	Get device user defined name. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetDeviceUserID (IN void handle, IN const char chValue)
	Set device user defined name. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetBurstFrameCount (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get frame number trigger by once. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetBurstFrameCount (IN void *handle, IN const unsigned int nValue)
	Set frame number trigger by once. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetAcquisitionLineRate (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get line rate. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetAcquisitionLineRate (IN void *handle, IN const unsigned int nValue)
	Set line rate. More...

MV_CAMCTRL_API int __stdcall	MV_CC_GetHeartBeatTimeout (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get heartbeat information. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetHeartBeatTimeout (IN void *handle, IN const unsigned int nValue)
	Set heartbeat information. More...

MV_CAMCTRL_API int __stdcall	MV_GIGE_GetGevSCPSPacketSize (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get network packet size. More...

MV_CAMCTRL_API int __stdcall	MV_GIGE_SetGevSCPSPacketSize (IN void *handle, IN const unsigned int nValue)
	Set network packet size. More...

MV_CAMCTRL_API int __stdcall	MV_GIGE_GetGevSCPD (IN void handle, IN OUT MVCC_INTVALUE pstValue)
	Get network packet sending delay. More...

MV_CAMCTRL_API int __stdcall	MV_GIGE_SetGevSCPD (IN void *handle, IN const unsigned int nValue)
	Set network packet sending delay. More...

MV_CAMCTRL_API int __stdcall	MV_GIGE_GetGevSCDA (IN void handle, unsigned int pnIP)
	Get receiver IP address, 0xa9fe0102 indicates 169.254.1.2. More...

MV_CAMCTRL_API int __stdcall	MV_GIGE_SetGevSCDA (IN void *handle, unsigned int nIP)
	Set receiver IP address. More...

MV_CAMCTRL_API int __stdcall	MV_GIGE_GetGevSCSP (IN void handle, unsigned int pnPort)
	Get transmitter port number. More...

MV_CAMCTRL_API int __stdcall	MV_GIGE_SetGevSCSP (IN void *handle, unsigned int nPort)
	Set transmitter port number. More...

MV_CAMCTRL_API int __stdcall	MV_CAML_SetDeviceBauderate (IN void *handle, unsigned int nBaudrate)
	Set device baudrate using one of the CL_BAUDRATE_XXXX value. More...

MV_CAMCTRL_API int __stdcall	MV_CAML_GetDeviceBauderate (IN void handle, unsigned int pnCurrentBaudrate)
	Returns the current device baudrate, using one of the CL_BAUDRATE_XXXX value. More...

MV_CAMCTRL_API int __stdcall	MV_CAML_GetSupportBauderates (IN void handle, unsigned int pnBaudrateAblity)
	Returns supported baudrates of the combined device and host interface. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SaveImageEx2 (IN void handle, MV_SAVE_IMAGE_PARAM_EX pstSaveParam)
	Save image, support Bmp and Jpeg. Encoding quality(50-99]. MV_CC_SaveImageEx3() is recommended. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SaveImageToFile (IN void handle, MV_SAVE_IMG_TO_FILE_PARAM pstSaveFileParam)
	Save the image file. MV_CC_SaveImageToFileEx() is recommended. More...

MV_CAMCTRL_API int __stdcall	MV_CC_ConvertPixelType (IN void handle, IN OUT MV_CC_PIXEL_CONVERT_PARAM pstCvtParam)
	Pixel format conversion. MV_CC_ConvertPixelTypeEx() is recommended. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SetSDKLogPath (IN const char *strSDKLogPath)
	Set SDK log path. More...

MV_CAMCTRL_API int __stdcall	MV_CC_EnumerateTls ()
	Get supported Transport Layer. More...

MV_CAMCTRL_API int __stdcall	MV_CC_CreateHandleWithoutLog (IN OUT void *handle, IN const MV_CC_DEVICE_INFO pstDevInfo)
	Create Device Handle without log. More...

MV_CAMCTRL_API int __stdcall	MV_CC_RegisterImageCallBackForRGB (IN void handle, IN void(__stdcall cbOutput)(unsigned char pData, MV_FRAME_OUT_INFO_EX pFrameInfo, void pUser), IN void pUser)
	register image data callback, RGB More...

MV_CAMCTRL_API int __stdcall	MV_CC_RegisterImageCallBackForBGR (IN void handle, IN void(__stdcall cbOutput)(unsigned char pData, MV_FRAME_OUT_INFO_EX pFrameInfo, void pUser), IN void pUser)
	register image data callback, BGR More...

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 *pstFrameInfo, IN int nMsec)
	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. More...

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 *pstFrameInfo, IN int nMsec)
	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. More...

MV_CAMCTRL_API int __stdcall	MV_CC_OpenParamsGUI (IN void *handle)
	Open the GUI interface for getting or setting camera parameters. More...

MV_CAMCTRL_API int __stdcall	MV_CC_SavePointCloudData (IN void handle, IN OUT MV_SAVE_POINT_CLOUD_PARAM pstPointDataParam)
	Save 3D point data, support PLY、CSV and OBJ. More...

Detailed Description

Reason: APIs of getting and setting parameters are replaced by newly developed ones; less effective APIs are replaced by more effective ones; some APIs are not often used in actual development.

Function Documentation

◆ MV_CC_GetImageInfo()

MV_CAMCTRL_API int __stdcall MV_CC_GetImageInfo	(	IN void *	handle,
		IN OUT MV_IMAGE_BASIC_INFO *	pstInfo
	)

Get basic information of image.

Parameters

handle	[IN] Handle
pstInfo	[IN][OUT] Structure pointer of image basic information

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to the definition of #MV_IMAGE_BASIC_INFO in CameraParams.h

◆ MV_CC_GetTlProxy()

MV_CAMCTRL_API void* __stdcall MV_CC_GetTlProxy ( IN void * handle )

Get GenICam proxy.

Parameters

handle [IN] Handle address

Returns: GenICam proxy pointer. The returned value is not NULL in normal situation, and NULL is returned when an exception occurs.

◆ MV_XML_GetRootNode()

MV_CAMCTRL_API int __stdcall MV_XML_GetRootNode	(	IN void *	handle,
		IN OUT MV_XML_NODE_FEATURE *	pstNode
	)

Get root node.

Parameters

handle	[IN] Handle
pstNode	[OUT] Root node information structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

◆ MV_XML_GetChildren()

MV_CAMCTRL_API int __stdcall MV_XML_GetChildren	(	IN void *	handle,
		IN MV_XML_NODE_FEATURE *	pstNode,
		IN OUT MV_XML_NODES_LIST *	pstNodesList
	)

Get all children node of specific node from xml, root node is Root.

Parameters

handle	[IN] Handle
pstNode	[IN] Root node information structure
pstNodesList	[OUT] Node information structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

◆ MV_XML_GetNodeFeature()

MV_CAMCTRL_API int __stdcall MV_XML_GetNodeFeature	(	IN void *	handle,
		IN MV_XML_NODE_FEATURE *	pstNode,
		IN OUT void *	pstFeature
	)

Get current node feature.

Parameters

handle	[IN] Handle
pstNode	[IN] Root node information structure
pstFeature	[OUT] Current node feature structure Details of pstFeature refer to MV_XML_FEATURE_x

Returns: Return MV_OK for success, and return corresponding error code for failure.

◆ MV_XML_UpdateNodeFeature()

MV_CAMCTRL_API int __stdcall MV_XML_UpdateNodeFeature	(	IN void *	handle,
		IN enum MV_XML_InterfaceType	enType,
		IN void *	pstFeature
	)

Update node.

Parameters

handle	[IN] Handle
enType	[IN] Node type
pstFeature	[OUT] Current node feature structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

◆ MV_XML_RegisterUpdateCallBack()

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
	)

Register update callback.

Parameters

handle	[IN] Handle
cbUpdate	[IN] Callback function pointer
pUser	[IN] User defined variable

Returns: Return MV_OK for success, and return corresponding error code for failure.

◆ MV_CC_GetOneFrame()

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
	)

Get one frame of image data. It was deprecated, and ::MV_CC_GetOneFrameTimeOut() is recommended.

Parameters

handle	[IN] Handle
pData	[OUT] Recevied image data pointer
nDataSize	[IN] Recevied buffer size
pFrameInfo	[OUT] Image information structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note

◆ MV_CC_GetOneFrameEx()

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
	)

Get one frame of trunck data. It was deprecated, and ::MV_CC_GetOneFrameTimeOut() is recommended.

Parameters

handle	[IN] Handle
pData	[OUT] Recevied image data pointer
nDataSize	[IN] Recevied buffer size
pFrameInfo	[OUT] Image information structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note

◆ MV_CC_RegisterImageCallBack()

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
	)

Register image data callback. It was deprecated, and MV_CC_RegisterImageCallBackEx() is recommended.

Parameters

handle	[IN] Handle
cbOutput	[IN] Callback function pointer
pUser	[IN] User defined variable

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note

◆ MV_CC_SaveImageEx()

MV_CAMCTRL_API int __stdcall MV_CC_SaveImageEx ( IN OUT MV_SAVE_IMAGE_PARAM_EX * pSaveParam )

Save image, support Bmp and Jpeg. Encoding quality, (50-99]. It was deprecated, and MV_CC_SaveImageEx3() is recommended.

Parameters

pSaveParam [IN][OUT] Save image parameters structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

◆ MV_CC_BayerNoiseEstimate()

MV_CAMCTRL_API int __stdcall MV_CC_BayerNoiseEstimate	(	IN void *	handle,
		IN OUT MV_CC_BAYER_NOISE_ESTIMATE_PARAM *	pstNoiseEstimateParam
	)

Bayer noise estimation.

Parameters

handle	[IN] Device handle
pstNoiseEstimateParam	[IN][OUT] Bayer noise estimation parameter structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: This API only support Bayer format.

◆ MV_CC_BayerSpatialDenoise()

MV_CAMCTRL_API int __stdcall MV_CC_BayerSpatialDenoise	(	IN void *	handle,
		IN OUT MV_CC_BAYER_SPATIAL_DENOISE_PARAM *	pstSpatialDenoiseParam
	)

Bayer airspace noise reduction.

Parameters

handle	[IN] Device handle
pstSpatialDenoiseParam	[IN][OUT] Bayer airspace noise reduction parameter structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: This API only support Bayer format.

◆ MV_CC_SetBayerCLUTParam()

MV_CAMCTRL_API int __stdcall MV_CC_SetBayerCLUTParam	(	IN void *	handle,
		IN MV_CC_CLUT_PARAM *	pstCLUTParam
	)

Set CLUT param.

Parameters

handle	[IN] Device handle
pstCLUTParam	[IN] CLUT parameter structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: After enable the CLUT and set CLUT, 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_CC_ImageSharpen()

MV_CAMCTRL_API int __stdcall MV_CC_ImageSharpen	(	IN void *	handle,
		IN OUT MV_CC_SHARPEN_PARAM *	pstSharpenParam
	)

Image sharpen.

Parameters

handle	[IN] Device handle
pstSharpenParam	[IN] Sharpen parameter structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

◆ MV_CC_ColorCorrect()

MV_CAMCTRL_API int __stdcall MV_CC_ColorCorrect	(	IN void *	handle,
		IN OUT MV_CC_COLOR_CORRECT_PARAM *	pstColorCorrectParam
	)

Color Correct(include CCM and CLUT)

Parameters

handle	[IN] Device handle
pstColorCorrectParam	[IN] Color Correct parameter structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: This API supports CCM or CLUT alone, as well as CCM and CLUT at the same time. The user can select by means of the enable switch in CCM and CLUT information.

◆ MV_CC_NoiseEstimate()

MV_CAMCTRL_API int __stdcall MV_CC_NoiseEstimate	(	IN void *	handle,
		IN OUT MV_CC_NOISE_ESTIMATE_PARAM *	pstNoiseEstimateParam
	)

Noise Estimate.

Parameters

handle	[IN] Device handle
pstNoiseEstimateParam	[IN] Noise Estimate parameter structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: If the user selects the full image, nROINum can be typed with 0 and pstROIRect empty.

◆ MV_CC_SpatialDenoise()

MV_CAMCTRL_API int __stdcall MV_CC_SpatialDenoise	(	IN void *	handle,
		IN OUT MV_CC_SPATIAL_DENOISE_PARAM *	pstSpatialDenoiseParam
	)

Spatial Denoise.

Parameters

handle	[IN] Device handle
pstSpatialDenoiseParam	[IN] Spatial Denoise parameter structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

◆ MV_CC_LSCCalib()

MV_CAMCTRL_API int __stdcall MV_CC_LSCCalib	(	IN void *	handle,
		IN OUT MV_CC_LSC_CALIB_PARAM *	pstLSCCalibParam
	)

LSC Calib.

Parameters

handle	[IN] Device handle
pstLSCCalibParam	[IN] LSC Calib parameter structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

◆ MV_CC_LSCCorrect()

MV_CAMCTRL_API int __stdcall MV_CC_LSCCorrect	(	IN void *	handle,
		IN OUT MV_CC_LSC_CORRECT_PARAM *	pstLSCCorrectParam
	)

LSC Correct.

Parameters

handle	[IN] Device handle
pstLSCCorrectParam	[IN] LSC Correct parameter structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

◆ MV_GIGE_ForceIp()

MV_CAMCTRL_API int __stdcall MV_GIGE_ForceIp	(	IN void *	handle,
		unsigned int	nIP
	)

Force IP. MV_GIGE_ForceIpEx() is recommended.

Parameters

handle	[IN] Handle
nIP	[IN] IP to set

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note

◆ MV_CC_RegisterEventCallBack()

MV_CAMCTRL_API int __stdcall MV_CC_RegisterEventCallBack	(	void *	handle,
		void(__stdcall cbEvent)(unsigned int nExternalEventId, void pUser)	,
		void *	pUser
	)

Register event callback. MV_CC_RegisterEventCallBackEx() is recommended.

Parameters

handle	[IN] Handle
cbEvent	[IN] event callback pointer
pUser	[IN] User defined value

Returns: Return MV_OK for success, and return corresponding error code for failure.

◆ MV_CC_Display()

MV_CAMCTRL_API int __stdcall MV_CC_Display	(	IN void *	handle,
		void *	hWnd
	)

Display one frame image, register display window, automatic display internally. It was deprecated, and MV_CC_DisplayOneFrameEx() is recommneded.

Parameters

handle	[IN] Handle
hWnd	[IN] Display Window Handle

Returns: Return MV_OK for success, and return corresponding error code for failure.

◆ MV_CC_DisplayOneFrame()

MV_CAMCTRL_API int __stdcall MV_CC_DisplayOneFrame	(	IN void *	handle,
		IN MV_DISPLAY_FRAME_INFO *	pstDisplayInfo
	)

Display one frame image. MV_CC_DisplayOneFrameEx2() is recommended.

Parameters

handle	[IN] Device handle
pstDisplayInfo	[IN] Frame Info

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: This API is valid for USB3Vision camera and GIGE camera.
This API is not supported by CameraLink device.

Parameters

handle	[IN] Device handle
pstDisplayInfo	[IN] Frame Info

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Not related to device type，When the render mode is D3D, the maximum resolution supported is 16384 * 163840

◆ MV_CC_GetIntValue()

MV_CAMCTRL_API int __stdcall MV_CC_GetIntValue	(	IN void *	handle,
		IN const char *	strKey,
		OUT MVCC_INTVALUE *	pIntValue
	)

Get Integer value.

Parameters

handle	[IN] Device handle
strKey	[IN] Key value, for example, using "Width" to get width
pIntValue	[IN][OUT] Structure pointer of camera features

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: 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.

Examples: GrabImage_HighPerformance.cpp, ImageProcess.cpp, ImageSave.cpp, and SetParam.cpp.

◆ MV_CC_SetIntValue()

MV_CAMCTRL_API int __stdcall MV_CC_SetIntValue	(	IN void *	handle,
		IN const char *	strKey,
		IN unsigned int	nValue
	)

Set Integer value.

Parameters

handle	[IN] Device handle
strKey	[IN] Key value, for example, using "Width" to set width
nValue	[IN] Feature value to set

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: 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.

Examples: ImageSave.cpp, and MultiLightCtrl_ImageStitching.cpp.

◆ MV_CC_GetWidth()

MV_CAMCTRL_API int __stdcall MV_CC_GetWidth	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get image width.

Parameters

handle [IN] Camera Handle

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

Returns: Success, return MV_OK , and get the structure of the corresponding parameters. Failure, return error code

Note: Other Integer structure parameters APIs can refer to this API.

◆ MV_CC_SetWidth()

MV_CAMCTRL_API int __stdcall MV_CC_SetWidth	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set image width.

Parameters

handle	[IN] Camera Handle
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

Returns: Success, return MV_OK , and the camera width will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetHeight()

MV_CAMCTRL_API int __stdcall MV_CC_GetHeight	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get image height.

Parameters

handle	[IN] Camera handle
pstValue	[IN][OUT] Return pointer of information structure related to camera height to user

Returns: Return MV_OK and height information to the structure for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_CC_SetHeight()

MV_CAMCTRL_API int __stdcall MV_CC_SetHeight	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set image height.

Parameters

handle	[IN] Camera Handle
nValue	[IN] Camera height value to set, note that this value must be times of nInc of pstValue returned by MV_CC_GetWidth

Returns: Return MV_OK and change height to set value for success, and return corresponding error code for failure.

Note

◆ MV_CC_GetAOIoffsetX()

MV_CAMCTRL_API int __stdcall MV_CC_GetAOIoffsetX	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get image X-axis offset.

Parameters

handle	[IN] Camera Handle
pstValue	[IN][OUT] Return pointer of information structure related to camera X offset to user

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth().

◆ MV_CC_SetAOIoffsetX()

MV_CAMCTRL_API int __stdcall MV_CC_SetAOIoffsetX	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set image AOI X-axis offset.

Parameters

handle	[IN] Camera handle.
nValue	[IN] Camera AOI X-axis offset value to set.

Returns: Return MV_OK for success, and change camera AOI X-axis offset to the set value, and return corresponding error code for failure.

Note

◆ MV_CC_GetAOIoffsetY()

MV_CAMCTRL_API int __stdcall MV_CC_GetAOIoffsetY	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get image Y-axis offset.

Parameters

handle	[IN] Camera handle.
pstValue	[IN][OUT] Return pointer of information structure related to camera Y offset to user.

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth().

◆ MV_CC_SetAOIoffsetY()

MV_CAMCTRL_API int __stdcall MV_CC_SetAOIoffsetY	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set image AOI Y-axis offset.

Parameters

handle	[IN] Camera handle.
nValue	[IN] Camera AOI Y-axis offset value to set.

Returns: Return MV_OK for success, and change camera AOI Y-axis offset to the set value, and return corresponding error code for failure.

Note

◆ MV_CC_GetAutoExposureTimeLower()

MV_CAMCTRL_API int __stdcall MV_CC_GetAutoExposureTimeLower	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get exposure lower limit.

Parameters

handle	[IN] Camera handle.
pstValue	[IN][OUT] Return pointer of information structure related to camera exposure lower to user.

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_CC_SetAutoExposureTimeLower()

MV_CAMCTRL_API int __stdcall MV_CC_SetAutoExposureTimeLower	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set exposure lower limit.

Parameters

handle	[IN] Camera Handle.
nValue	[IN] Exposure lower to set.

Returns: Return MV_OK ands change the exposure lower limit to set value for success, and return corresponding error code for failure.

Note

◆ MV_CC_GetAutoExposureTimeUpper()

MV_CAMCTRL_API int __stdcall MV_CC_GetAutoExposureTimeUpper	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get exposure upper limit.

Parameters

handle	[IN] Camera Handle
pstValue	[IN][OUT] Return pointer of information structure related to camera exposure upper to user

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_CC_SetAutoExposureTimeUpper()

MV_CAMCTRL_API int __stdcall MV_CC_SetAutoExposureTimeUpper	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set exposure upper limit.

Parameters

handle	[IN] Camera Handle
nValue	[IN] Exposure upper to set

Returns: Success, return MV_OK , and the camera exposure time upper limit value will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetBrightness()

MV_CAMCTRL_API int __stdcall MV_CC_GetBrightness	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get brightness.

Parameters

handle	[IN] Camera Handle
pstValue	[IN][OUT] Return pointer of information structure related to camera brightness to user

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_CC_SetBrightness()

MV_CAMCTRL_API int __stdcall MV_CC_SetBrightness	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set brightness.

Parameters

handle	[IN] Camera Handle
nValue	[IN] Brightness upper to set

Returns: Success, return MV_OK , and the camera brightness value will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetFrameRate()

MV_CAMCTRL_API int __stdcall MV_CC_GetFrameRate	(	IN void *	handle,
		IN OUT MVCC_FLOATVALUE *	pstValue
	)

Get Frame Rate.

Parameters

handle	[IN] Camera Handle
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

Returns: Success, return MV_OK , and get the structure of the corresponding parameters. Failure, return error code

Note: Other interface of Float structure parameters can refer to this interface

◆ MV_CC_SetFrameRate()

MV_CAMCTRL_API int __stdcall MV_CC_SetFrameRate	(	IN void *	handle,
		IN const float	fValue
	)

Set frame rate.

Parameters

handle	[IN] Camera Handle
fValue	[IN] Camera frame rate to set

Returns: Success, return MV_OK , and camera frame rate will be changed to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetGain()

MV_CAMCTRL_API int __stdcall MV_CC_GetGain	(	IN void *	handle,
		IN OUT MVCC_FLOATVALUE *	pstValue
	)

Get Gain.

Parameters

handle	[IN] Camera Handle
pstValue	[IN][OUT] Return pointer of information structure related to gain to user

Returns

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

Success, return MV_OK , and get the structure of the corresponding parameters. Failure, return error code

Note: Other interface of Float structure parameters can refer to this interface

◆ MV_CC_SetGain()

MV_CAMCTRL_API int __stdcall MV_CC_SetGain	(	IN void *	handle,
		IN const float	fValue
	)

Set Gain.

Parameters

handle	[IN] Camera Handle
fValue	[IN] Gain value to set

Returns

Success, return MV_OK , and the camera gain value will change to the corresponding value. Failure, return error code

◆ MV_CC_GetExposureTime()

MV_CAMCTRL_API int __stdcall MV_CC_GetExposureTime	(	IN void *	handle,
		IN OUT MVCC_FLOATVALUE *	pstValue
	)

Get exposure time.

Parameters

handle	[IN] Camera Handle
pstValue	[IN][OUT] Return pointer of information structure related to exposure time to user

Returns

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

Success, return MV_OK , and get the structure of the corresponding parameters. Failure, return error code

Note: Other interface of Float structure parameters can refer to this interface

◆ MV_CC_SetExposureTime()

MV_CAMCTRL_API int __stdcall MV_CC_SetExposureTime	(	IN void *	handle,
		IN const float	fValue
	)

Set exposure time.

Parameters

handle	[IN] Camera Handle
fValue	[IN] Exposure time to set

Returns: Success, return MV_OK , and the camera exposure time value will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetPixelFormat()

MV_CAMCTRL_API int __stdcall MV_CC_GetPixelFormat	(	IN void *	handle,
		IN OUT MVCC_ENUMVALUE *	pstValue
	)

Get Pixel Format.

Parameters

handle [IN] Camera Handle

pstValue

[IN][OUT] Returns the information structure pointer about pixel format for the caller
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

Returns: Success, return MV_OK , and get the structure of the corresponding parameters. Failure, return error code

Note: 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_CC_SetPixelFormat()

MV_CAMCTRL_API int __stdcall MV_CC_SetPixelFormat	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set Pixel Format.

Parameters

handle	[IN] Camera Handle
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);

Returns: Success, return MV_OK , and the camera pixel format will change to the corresponding value. Failure, return error code

Note: 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_CC_GetAcquisitionMode()

MV_CAMCTRL_API int __stdcall MV_CC_GetAcquisitionMode	(	IN void *	handle,
		IN OUT MVCC_ENUMVALUE *	pstValue
	)

Get acquisition mode.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of acquisition mode

Returns: Success, return MV_OK , and get the structure of the corresponding parameters. Failure, return error code

Note: Refer to MV_CC_GetPixelFormat and definition of MV_CAM_ACQUISITION_MODE in CameraParams.h

◆ MV_CC_SetAcquisitionMode()

MV_CAMCTRL_API int __stdcall MV_CC_SetAcquisitionMode	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set acquisition mode.

Parameters

handle	[IN] Handle
nValue	[IN] Integer value to set corresponding to acquisition mode

Returns: Success, return MV_OK , and the camera acquisition mode will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetGainMode()

MV_CAMCTRL_API int __stdcall MV_CC_GetGainMode	(	IN void *	handle,
		IN OUT MVCC_ENUMVALUE *	pstValue
	)

Get gain mode.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of gain mode

Returns: Success, return MV_OK , and get the structure of the corresponding parameters. Failure, return error code

Note: Refer to MV_CC_GetPixelFormat and definition of MV_CAM_GAIN_MODE in CameraParams.h

◆ MV_CC_SetGainMode()

MV_CAMCTRL_API int __stdcall MV_CC_SetGainMode	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set gain mode.

Parameters

handle	[IN] Handle
nValue	[IN] Integer value to set corresponding to gain mode

Returns: Success, return MV_OK , and the camera gain mode will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetExposureAutoMode()

MV_CAMCTRL_API int __stdcall MV_CC_GetExposureAutoMode	(	IN void *	handle,
		IN OUT MVCC_ENUMVALUE *	pstValue
	)

Get auto exposure mode.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of auto exposure mode

Returns: Success, return MV_OK , and get the structure of the corresponding parameters. Failure, return error code

Note: Refer to MV_CC_GetPixelFormat and definition of MV_CAM_EXPOSURE_AUTO_MODE in CameraParams.h

◆ MV_CC_SetExposureAutoMode()

MV_CAMCTRL_API int __stdcall MV_CC_SetExposureAutoMode	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set auto exposure mode.

Parameters

handle	[IN] Handle
nValue	[IN] Integer value to set corresponding to auto exposure mode

Returns: Success, return MV_OK , and the camera auto exposure mode will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetTriggerMode()

MV_CAMCTRL_API int __stdcall MV_CC_GetTriggerMode	(	IN void *	handle,
		IN OUT MVCC_ENUMVALUE *	pstValue
	)

Get trigger mode.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of trigger mode

Returns: Success, return MV_OK , and get the structure of the corresponding parameters. Failure, return error code

Note: Refer to MV_CC_GetPixelFormat and definition of MV_CAM_TRIGGER_MODE in CameraParams.h

◆ MV_CC_SetTriggerMode()

MV_CAMCTRL_API int __stdcall MV_CC_SetTriggerMode	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set trigger mode.

Parameters

handle	[IN] Handle
nValue	[IN] Integer value to set corresponding to trigger mode

Returns: Success, return MV_OK , and the camera trigger mode will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetTriggerDelay()

MV_CAMCTRL_API int __stdcall MV_CC_GetTriggerDelay	(	IN void *	handle,
		IN OUT MVCC_FLOATVALUE *	pstValue
	)

Get tigger delay.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of trigger delay

Returns: Success, return MV_OK , and get the structure of the corresponding parameters. Failure, return error code

Note: Refer to MV_CC_GetFrameRate

◆ MV_CC_SetTriggerDelay()

MV_CAMCTRL_API int __stdcall MV_CC_SetTriggerDelay	(	IN void *	handle,
		IN const float	fValue
	)

Set tigger delay.

Parameters

handle	[IN] Handle
fValue	[IN] Trigger delay to set

Returns: Success, return MV_OK , and the camera trigger delay will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetTriggerSource()

MV_CAMCTRL_API int __stdcall MV_CC_GetTriggerSource	(	IN void *	handle,
		IN OUT MVCC_ENUMVALUE *	pstValue
	)

Get trigger source.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of trigger source

Returns: Success, return MV_OK , and get the structure of the corresponding parameters. Failure, return error code

Note: Refer to MV_CC_GetPixelFormat and definition of MV_CAM_TRIGGER_SOURCE in CameraParams.h

◆ MV_CC_SetTriggerSource()

MV_CAMCTRL_API int __stdcall MV_CC_SetTriggerSource	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set trigger source.

Parameters

handle	[IN] Handle
nValue	[IN] Integer value to set corresponding to trigger source

Returns: Success, return MV_OK , and the camera trigger source will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_TriggerSoftwareExecute()

MV_CAMCTRL_API int __stdcall MV_CC_TriggerSoftwareExecute ( IN void * handle )

Execute software trigger once (this interface only valid when the trigger source is set to software)

Parameters

handle [IN] Handle

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note

◆ MV_CC_GetGammaSelector()

MV_CAMCTRL_API int __stdcall MV_CC_GetGammaSelector	(	IN void *	handle,
		IN OUT MVCC_ENUMVALUE *	pstValue
	)

Get Gamma mode.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of gamma mode

Returns: Success, return MV_OK , and get the structure of the corresponding parameters. Failure, return error code

Note: Refer to MV_CC_GetPixelFormat and definition of MV_CAM_GAMMA_SELECTOR in CameraParams.h

◆ MV_CC_SetGammaSelector()

MV_CAMCTRL_API int __stdcall MV_CC_SetGammaSelector	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set Gamma mode.

Parameters

handle	[IN] Handle
nValue	[IN] Integer value to set corresponding to gamma mode

Returns: Success, return MV_OK , and the camera gamma mode will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetGamma()

MV_CAMCTRL_API int __stdcall MV_CC_GetGamma	(	IN void *	handle,
		IN OUT MVCC_FLOATVALUE *	pstValue
	)

Get Gamma value.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of gamma value

Returns: Success, return MV_OK , and get the structure of the corresponding parameters. Failure, return error code

Note: Refer to MV_CC_GetFrameRate

◆ MV_CC_SetGamma()

MV_CAMCTRL_API int __stdcall MV_CC_SetGamma	(	IN void *	handle,
		IN const float	fValue
	)

Set Gamma value.

Parameters

handle	[IN] Handle
fValue	[IN] Gamma value to set

Returns: Success, return MV_OK , and the camera gamma value will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetSharpness()

MV_CAMCTRL_API int __stdcall MV_CC_GetSharpness	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get sharpness.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of sharpness

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_CC_SetSharpness()

MV_CAMCTRL_API int __stdcall MV_CC_SetSharpness	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set sharpness.

Parameters

handle	[IN] Handle
nValue	[IN] Sharpness to set

Returns: Success, return MV_OK , and the camera sharpness will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetHue()

MV_CAMCTRL_API int __stdcall MV_CC_GetHue	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get Hue.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of Hue

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_CC_SetHue()

MV_CAMCTRL_API int __stdcall MV_CC_SetHue	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set Hue.

Parameters

handle	[IN] Handle
nValue	[IN] Hue to set

Returns: Success, return MV_OK , and the camera Hue will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetSaturation()

MV_CAMCTRL_API int __stdcall MV_CC_GetSaturation	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get Saturation.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of Saturation

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_CC_SetSaturation()

MV_CAMCTRL_API int __stdcall MV_CC_SetSaturation	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set Saturation.

Parameters

handle	[IN] Handle
nValue	[IN] Saturation to set

Returns: Success, return MV_OK , and the camera Saturation will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetBalanceWhiteAuto()

MV_CAMCTRL_API int __stdcall MV_CC_GetBalanceWhiteAuto	(	IN void *	handle,
		IN OUT MVCC_ENUMVALUE *	pstValue
	)

Get Auto white balance.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of auto white balance

Returns: Success, return MV_OK , and get the structure of the corresponding parameters. Failure, return error code

Note: Refer to MV_CC_GetPixelFormat and definition of MV_CAM_BALANCEWHITE_AUTO in CameraParams.h

◆ MV_CC_SetBalanceWhiteAuto()

MV_CAMCTRL_API int __stdcall MV_CC_SetBalanceWhiteAuto	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set Auto white balance.

Parameters

handle	[IN] Handle
nValue	[IN] Integer value to set corresponding to auto white balance

Returns: Success, return MV_OK , and the camera auto white balance will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetBalanceRatioRed()

MV_CAMCTRL_API int __stdcall MV_CC_GetBalanceRatioRed	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get white balance red.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of white balance red

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_CC_SetBalanceRatioRed()

MV_CAMCTRL_API int __stdcall MV_CC_SetBalanceRatioRed	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set white balance red.

Parameters

handle	[IN] Handle
nValue	[IN] White balance red to set

Returns: Success, return MV_OK , and the camera white balance red will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetBalanceRatioGreen()

MV_CAMCTRL_API int __stdcall MV_CC_GetBalanceRatioGreen	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get white balance green.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of white balance green

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_CC_SetBalanceRatioGreen()

MV_CAMCTRL_API int __stdcall MV_CC_SetBalanceRatioGreen	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set white balance green.

Parameters

handle	[IN] Handle
nValue	[IN] White balance green to set

Returns: Success, return MV_OK , and the camera white balance green will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetBalanceRatioBlue()

MV_CAMCTRL_API int __stdcall MV_CC_GetBalanceRatioBlue	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get white balance blue.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of white balance blue

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_CC_SetBalanceRatioBlue()

MV_CAMCTRL_API int __stdcall MV_CC_SetBalanceRatioBlue	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set white balance blue.

Parameters

handle	[IN] Handle
nValue	[IN] White balance blue to set

Returns: Success, return MV_OK , and the camera white balance blue will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetFrameSpecInfoAbility()

MV_CAMCTRL_API int __stdcall MV_CC_GetFrameSpecInfoAbility	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get information type included by frame stamp.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of information type included by frame stamp

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_CC_SetFrameSpecInfoAbility()

MV_CAMCTRL_API int __stdcall MV_CC_SetFrameSpecInfoAbility	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set information type included by frame stamp.

Parameters

handle	[IN] Handle
nValue	[IN] Information type included by frame stamp to set

Returns: Success, return MV_OK , and the camera information type included by frame stamp will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetDeviceUserID()

MV_CAMCTRL_API int __stdcall MV_CC_GetDeviceUserID	(	IN void *	handle,
		IN OUT MVCC_STRINGVALUE *	pstValue
	)

Get device user defined name.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of device name

Returns: Success, return MV_OK , and get the camera user defined name. Failure, return error code

Note

◆ MV_CC_SetDeviceUserID()

MV_CAMCTRL_API int __stdcall MV_CC_SetDeviceUserID	(	IN void *	handle,
		IN const char *	chValue
	)

Set device user defined name.

Parameters

handle	[IN] Handle
chValue	[IN] Device name

Returns: Success, return MV_OK , and set the camera user defined name. Failure, return error code

Note

◆ MV_CC_GetBurstFrameCount()

MV_CAMCTRL_API int __stdcall MV_CC_GetBurstFrameCount	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get frame number trigger by once.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of frame number trigger by once

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_CC_SetBurstFrameCount()

MV_CAMCTRL_API int __stdcall MV_CC_SetBurstFrameCount	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set frame number trigger by once.

Parameters

handle	[IN] Handle
nValue	[IN] Frame number trigger by once to set

Returns: Success, return MV_OK , and the camera frame number trigger by once will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetAcquisitionLineRate()

MV_CAMCTRL_API int __stdcall MV_CC_GetAcquisitionLineRate	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get line rate.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of line rate

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_CC_SetAcquisitionLineRate()

MV_CAMCTRL_API int __stdcall MV_CC_SetAcquisitionLineRate	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set line rate.

Parameters

handle	[IN] Handle
nValue	[IN] Line rate to set

Returns: Success, return MV_OK , and the camera line rate will change to the corresponding value. Failure, return error code

Note

◆ MV_CC_GetHeartBeatTimeout()

MV_CAMCTRL_API int __stdcall MV_CC_GetHeartBeatTimeout	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get heartbeat information.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of heartbeat information

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_CC_SetHeartBeatTimeout()

MV_CAMCTRL_API int __stdcall MV_CC_SetHeartBeatTimeout	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set heartbeat information.

Parameters

handle	[IN] Handle
nValue	[IN] Heartbeat information to set

Returns: Success, return MV_OK , and the camera heartbeat information will change to the corresponding value. Failure, return error code

Note

◆ MV_GIGE_GetGevSCPSPacketSize()

MV_CAMCTRL_API int __stdcall MV_GIGE_GetGevSCPSPacketSize	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get network packet size.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of network packet size

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_GIGE_SetGevSCPSPacketSize()

MV_CAMCTRL_API int __stdcall MV_GIGE_SetGevSCPSPacketSize	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set network packet size.

Parameters

handle	[IN] Handle
nValue	[IN] Packet size to set

Returns: Success, return MV_OK , and change packet size to setting value. Failure, return error code

◆ MV_GIGE_GetGevSCPD()

MV_CAMCTRL_API int __stdcall MV_GIGE_GetGevSCPD	(	IN void *	handle,
		IN OUT MVCC_INTVALUE *	pstValue
	)

Get network packet sending delay.

Parameters

handle	[IN] Handle
pstValue	[IN][OUT] Structure pointer of network packet sending delay

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Refer to MV_CC_GetWidth

◆ MV_GIGE_SetGevSCPD()

MV_CAMCTRL_API int __stdcall MV_GIGE_SetGevSCPD	(	IN void *	handle,
		IN const unsigned int	nValue
	)

Set network packet sending delay.

Parameters

handle	[IN] Handle
nValue	[IN] Packet delay to set

Returns: Success, return MV_OK , and change packet delay to setting value. Failure, return error code

◆ MV_GIGE_GetGevSCDA()

MV_CAMCTRL_API int __stdcall MV_GIGE_GetGevSCDA	(	IN void *	handle,
		unsigned int *	pnIP
	)

Get receiver IP address, 0xa9fe0102 indicates 169.254.1.2.

Parameters

handle	[IN] Handle
pnIP	[IN][OUT] Receiver IP address

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note

◆ MV_GIGE_SetGevSCDA()

MV_CAMCTRL_API int __stdcall MV_GIGE_SetGevSCDA	(	IN void *	handle,
		unsigned int	nIP
	)

Set receiver IP address.

Parameters

handle [IN] Handel unsigned int nIP [IN] Receiver IP address to set

Returns: Return MV_OK for success and change receiver IP address to set value, and return corresponding error code for failure.

Note

◆ MV_GIGE_GetGevSCSP()

MV_CAMCTRL_API int __stdcall MV_GIGE_GetGevSCSP	(	IN void *	handle,
		unsigned int *	pnPort
	)

Get transmitter port number.

Parameters

handle	[IN] Handle
pnPort	[IN][OUT] Transmitter port number

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note

◆ MV_GIGE_SetGevSCSP()

MV_CAMCTRL_API int __stdcall MV_GIGE_SetGevSCSP	(	IN void *	handle,
		unsigned int	nPort
	)

Set transmitter port number.

Parameters

handle	[IN] Handle
nPort	[IN] Transmitter port number to set

Returns: Return MV_OK for success and change transmitter port No. to set value, and return corresponding error code for failure.

Note

◆ MV_CAML_SetDeviceBauderate()

MV_CAMCTRL_API int __stdcall MV_CAML_SetDeviceBauderate	(	IN void *	handle,
		unsigned int	nBaudrate
	)

Set device baudrate using one of the CL_BAUDRATE_XXXX value.

Parameters

handle	[IN] Device handle
nBaudrate	[IN] baud rate to set. Refer to the 'CameraParams.h' for parameter definitions, for example, #define MV_CAML_BAUDRATE_9600 0x00000001

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: MV_CAML_SetDeviceBaudrate() is recommended.

◆ MV_CAML_GetDeviceBauderate()

MV_CAMCTRL_API int __stdcall MV_CAML_GetDeviceBauderate	(	IN void *	handle,
		unsigned int *	pnCurrentBaudrate
	)

Returns the current device baudrate, using one of the CL_BAUDRATE_XXXX value.

Parameters

handle	[IN] Device handle
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

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: MV_CAML_GetDeviceBaudrate() is recommended.

◆ MV_CAML_GetSupportBauderates()

MV_CAMCTRL_API int __stdcall MV_CAML_GetSupportBauderates	(	IN void *	handle,
		unsigned int *	pnBaudrateAblity
	)

Returns supported baudrates of the combined device and host interface.

Parameters

handle	[IN] Device handle
pnBaudrateAblity	[OUT] Return pointer of the supported baudrates to user. 'OR' operation results of the supported baudrates. Refer to the 'CameraParams.h' for single value definitions, for example, MV_CAML_BAUDRATE_9600 0x00000001

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: MV_CAML_GetSupportBaudrates() is recommended.

◆ MV_CC_SaveImageEx2()

MV_CAMCTRL_API int __stdcall MV_CC_SaveImageEx2	(	IN void *	handle,
		MV_SAVE_IMAGE_PARAM_EX *	pstSaveParam
	)

Save image, support Bmp and Jpeg. Encoding quality(50-99]. MV_CC_SaveImageEx3() is recommended.

Parameters

handle	[IN] Device handle
pstSaveParam	[IN][OUT] Save image parameters structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note

Once there is image data, you can call this API to convert the data.
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.
Comparing with the API MV_CC_SaveImageEx, this API added the parameter handle to ensure the unity with other API.

Examples: ImageProcess.cpp.

◆ MV_CC_SaveImageToFile()

MV_CAMCTRL_API int __stdcall MV_CC_SaveImageToFile	(	IN void *	handle,
		MV_SAVE_IMG_TO_FILE_PARAM *	pstSaveFileParam
	)

Save the image file. MV_CC_SaveImageToFileEx() is recommended.

Parameters

handle	[IN] Device handle
pstSaveFileParam	[IN][OUT] Save the image file parameter structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: This API support BMP/JPEG/PNG/TIFF.

◆ MV_CC_ConvertPixelType()

MV_CAMCTRL_API int __stdcall MV_CC_ConvertPixelType	(	IN void *	handle,
		IN OUT MV_CC_PIXEL_CONVERT_PARAM *	pstCvtParam
	)

Pixel format conversion. MV_CC_ConvertPixelTypeEx() is recommended.

Parameters

handle	[IN] Device handle
pstCvtParam	[IN][OUT] Convert Pixel Type parameter structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: 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.

Examples: ImageProcess.cpp.

◆ MV_CC_SetSDKLogPath()

MV_CAMCTRL_API int __stdcall MV_CC_SetSDKLogPath ( IN const char * strSDKLogPath )

Set SDK log path.

Parameters

strSDKLogPath [IN] SDK log path

Returns: Access, return true. Not access, return false

Note: 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 This API is used to set the log file storing path.

◆ MV_CC_EnumerateTls()

MV_CAMCTRL_API int __stdcall MV_CC_EnumerateTls ( )

Get supported Transport Layer.

Returns: Supported Transport Layer number

◆ MV_CC_CreateHandleWithoutLog()

MV_CAMCTRL_API int __stdcall MV_CC_CreateHandleWithoutLog	(	IN OUT void **	handle,
		IN const MV_CC_DEVICE_INFO *	pstDevInfo
	)

Create Device Handle without log.

Parameters

handle	[IN][OUT] Device handle
pstDevInfo	[IN] Device Information Structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: 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_CC_RegisterImageCallBackForRGB()

MV_CAMCTRL_API int __stdcall MV_CC_RegisterImageCallBackForRGB	(	IN void *	handle,
		IN	void__stdcall cbOutput)(unsigned char pData, MV_FRAME_OUT_INFO_EX pFrameInfo, void pUser,
		IN void *	pUser
	)

register image data callback, RGB

Parameters

handle	[IN] Device handle
cbOutput	[IN] Callback function pointer
pUser	[IN] User defined variable

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Before calling this API to set image data callback function, you should call this API MV_CC_CreateHandle() .
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.
This API is not supported by CameraLink device.

◆ MV_CC_RegisterImageCallBackForBGR()

MV_CAMCTRL_API int __stdcall MV_CC_RegisterImageCallBackForBGR	(	IN void *	handle,
		IN	void__stdcall cbOutput)(unsigned char pData, MV_FRAME_OUT_INFO_EX pFrameInfo, void pUser,
		IN void *	pUser
	)

register image data callback, BGR

Parameters

handle	[IN] Device handle
cbOutput	[IN] Callback function pointer
pUser	[IN] User defined variable

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Before calling this API to set image data callback function, you should call this API MV_CC_CreateHandle() .
There are two image acquisition modes, the two modes cannot be reused:
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.
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.
This API is not supported by CameraLink device.

◆ MV_CC_GetImageForRGB()

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 *	pstFrameInfo,
		IN int	nMsec
	)

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.

Parameters

handle	[IN] Device handle
pData	[IN][OUT] Image data receiving buffer
nDataSize	[IN] Buffer size
pstFrameInfo	[IN][OUT] Image information structure
nMsec	[IN] Waiting timeout

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Each time the API is called, the internal cache is checked for data. If there is data, it will be transformed as RGB24 format for return, if there is no data, return error code. As time-consuming exists when transform the image to RGB24 format, this API may cause frame loss when the data frame rate is too high.
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 is not supported by CameraLink device.

◆ MV_CC_GetImageForBGR()

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 *	pstFrameInfo,
		IN int	nMsec
	)

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.

Parameters

handle	[IN] Device handle
pData	[IN][OUT] Image data receiving buffer
nDataSize	[IN] Buffer size
pstFrameInfo	[IN][OUT] Image information structure
nMsec	[IN] Waiting timeout

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Before calling this API to set image data callback function, you should call this API MV_CC_CreateHandle() .
There are two image acquisition modes, the two modes cannot be reused:
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.
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.
This API is not supported by CameraLink device.

◆ MV_CC_OpenParamsGUI()

MV_CAMCTRL_API int __stdcall MV_CC_OpenParamsGUI ( IN void * handle )

Open the GUI interface for getting or setting camera parameters.

Parameters

handle [IN] Device handle

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: After connecting to device through MV_CC_OpenDevice, use this interface to get or set device params.

◆ MV_CC_SavePointCloudData()

MV_CAMCTRL_API int __stdcall MV_CC_SavePointCloudData	(	IN void *	handle,
		IN OUT MV_SAVE_POINT_CLOUD_PARAM *	pstPointDataParam
	)

Save 3D point data, support PLY、CSV and OBJ.

Parameters

handle	[IN] Device handle
pstPointDataParam	[IN][OUT] Save 3D point data parameters structure

Returns: Return MV_OK for success, and return corresponding error code for failure.

Note: Save the 3D data format to 3D file format，support PLY、CSV and OBJ，/n only support PixelType_Gvsp_Coord3D_ABC32、PixelType_Gvsp_Coord3D_ABC32f、PixelType_Gvsp_Coord3D_AB32、PixelType_Gvsp_Coord3D_AB32f、PixelType_Gvsp_Coord3D_AC32、PixelType_Gvsp_Coord3D_AC32f,Other 3D format is not supported now.

Functions

Detailed Description

Function Documentation

◆ MV_CC_GetImageInfo()

◆ MV_CC_GetTlProxy()

◆ MV_XML_GetRootNode()

◆ MV_XML_GetChildren()

◆ MV_XML_GetNodeFeature()

◆ MV_XML_UpdateNodeFeature()

◆ MV_XML_RegisterUpdateCallBack()

◆ MV_CC_GetOneFrame()

◆ MV_CC_GetOneFrameEx()

◆ MV_CC_RegisterImageCallBack()

◆ MV_CC_SaveImageEx()

◆ MV_CC_BayerNoiseEstimate()

◆ MV_CC_BayerSpatialDenoise()

◆ MV_CC_SetBayerCLUTParam()

◆ MV_CC_ImageSharpen()

◆ MV_CC_ColorCorrect()

◆ MV_CC_NoiseEstimate()

◆ MV_CC_SpatialDenoise()

◆ MV_CC_LSCCalib()

◆ MV_CC_LSCCorrect()

◆ MV_GIGE_ForceIp()

◆ MV_CC_RegisterEventCallBack()

◆ MV_CC_Display()

◆ MV_CC_DisplayOneFrame()

◆ MV_CC_GetIntValue()

◆ MV_CC_SetIntValue()

◆ MV_CC_GetWidth()

◆ MV_CC_SetWidth()

◆ MV_CC_GetHeight()

◆ MV_CC_SetHeight()

◆ MV_CC_GetAOIoffsetX()

◆ MV_CC_SetAOIoffsetX()

◆ MV_CC_GetAOIoffsetY()

◆ MV_CC_SetAOIoffsetY()

◆ MV_CC_GetAutoExposureTimeLower()

◆ MV_CC_SetAutoExposureTimeLower()

◆ MV_CC_GetAutoExposureTimeUpper()

◆ MV_CC_SetAutoExposureTimeUpper()

◆ MV_CC_GetBrightness()

◆ MV_CC_SetBrightness()

◆ MV_CC_GetFrameRate()

◆ MV_CC_SetFrameRate()

◆ MV_CC_GetGain()

◆ MV_CC_SetGain()

◆ MV_CC_GetExposureTime()

◆ MV_CC_SetExposureTime()

◆ MV_CC_GetPixelFormat()

◆ MV_CC_SetPixelFormat()

◆ MV_CC_GetAcquisitionMode()

◆ MV_CC_SetAcquisitionMode()

◆ MV_CC_GetGainMode()

◆ MV_CC_SetGainMode()

◆ MV_CC_GetExposureAutoMode()

◆ MV_CC_SetExposureAutoMode()

◆ MV_CC_GetTriggerMode()

◆ MV_CC_SetTriggerMode()

◆ MV_CC_GetTriggerDelay()

◆ MV_CC_SetTriggerDelay()

◆ MV_CC_GetTriggerSource()

◆ MV_CC_SetTriggerSource()

◆ MV_CC_TriggerSoftwareExecute()

◆ MV_CC_GetGammaSelector()

◆ MV_CC_SetGammaSelector()

◆ MV_CC_GetGamma()

◆ MV_CC_SetGamma()

◆ MV_CC_GetSharpness()

◆ MV_CC_SetSharpness()

◆ MV_CC_GetHue()

◆ MV_CC_SetHue()

◆ MV_CC_GetSaturation()

◆ MV_CC_SetSaturation()

◆ MV_CC_GetBalanceWhiteAuto()

◆ MV_CC_SetBalanceWhiteAuto()

◆ MV_CC_GetBalanceRatioRed()

◆ MV_CC_SetBalanceRatioRed()

◆ MV_CC_GetBalanceRatioGreen()

◆ MV_CC_SetBalanceRatioGreen()