Attribute Configuration

General APIs for getting and configuring camera parameters. More...

Functions
MV_CAMCTRL_API int __stdcall	MV_CC_GetIntValueEx (IN void *handle, IN const char *strKey, IN OUT MVCC_INTVALUE_EX *pstIntValue)
	Get the value of camera integer type node. More...
MV_CAMCTRL_API int __stdcall	MV_CC_SetIntValueEx (IN void *handle, IN const char *strKey, IN int64_t nValue)
	Set the value of camera integer type node. More...
MV_CAMCTRL_API int __stdcall	MV_CC_GetEnumValue (IN void *handle, IN const char *strKey, IN OUT MVCC_ENUMVALUE *pstEnumValue)
	Get the value of camera Enum type node. More...
MV_CAMCTRL_API int __stdcall	MV_CC_GetEnumValueEx (IN void *handle, IN const char *strKey, IN OUT MVCC_ENUMVALUE_EX *pstEnumValue)
	Get the value of camera Enum type node (extended API). More...
MV_CAMCTRL_API int __stdcall	MV_CC_SetEnumValue (IN void *handle, IN const char *strKey, IN unsigned int nValue)
	Set the value of camera Enum type node. More...
MV_CAMCTRL_API int __stdcall	MV_CC_GetEnumEntrySymbolic (IN void *handle, IN const char *strKey, IN OUT MVCC_ENUMENTRY *pstEnumEntry)
	Get the enumerator name according to the node name and assigned value. More...
MV_CAMCTRL_API int __stdcall	MV_CC_SetEnumValueByString (IN void *handle, IN const char *strKey, IN const char *strValue)
	Set the value of camera Enum type node. More...
MV_CAMCTRL_API int __stdcall	MV_CC_GetFloatValue (IN void *handle, IN const char *strKey, IN OUT MVCC_FLOATVALUE *pstFloatValue)
	Get the value of camera float type node. More...
MV_CAMCTRL_API int __stdcall	MV_CC_SetFloatValue (IN void *handle, IN const char *strKey, IN float fValue)
	Set the value of camera float type node. More...
MV_CAMCTRL_API int __stdcall	MV_CC_GetBoolValue (IN void *handle, IN const char *strKey, IN OUT bool *pbValue)
	Get the value of camera bool type node. More...
MV_CAMCTRL_API int __stdcall	MV_CC_SetBoolValue (IN void *handle, IN const char *strKey, IN bool bValue)
	Set Boolean value. More...
MV_CAMCTRL_API int __stdcall	MV_CC_GetStringValue (IN void *handle, IN const char *strKey, IN OUT MVCC_STRINGVALUE *pstStringValue)
	Get the value of camera string type node. More...
MV_CAMCTRL_API int __stdcall	MV_CC_SetStringValue (IN void *handle, IN const char *strKey, IN const char *strValue)
	Set the camera value of string type. More...
MV_CAMCTRL_API int __stdcall	MV_CC_SetCommandValue (IN void *handle, IN const char *strKey)
	Set the camera Command node. More...
MV_CAMCTRL_API int __stdcall	MV_CC_FeatureSave (IN void *handle, IN const char *strFileName)
	Save camera feature. More...
MV_CAMCTRL_API int __stdcall	MV_CC_FeatureLoad (IN void *handle, IN const char *strFileName)
	Import camera feature. More...
MV_CAMCTRL_API int __stdcall	MV_CC_FeatureLoadEx (IN void *handle, IN const char *strFileName, IN OUT MVCC_NODE_ERROR_LIST *pstNodeErrorList)
	Import camera feature with error message list. More...

Detailed Description

General APIs for getting and configuring camera parameters.

Function Documentation

MV_CC_GetIntValueEx()

MV_CAMCTRL_API int __stdcall MV_CC_GetIntValueEx	(	IN void *	handle,
		IN const char *	strKey,
		IN OUT MVCC_INTVALUE_EX *	pstIntValue
	)

Get the value of camera integer type node.

Parameters

handle	[IN] Device handle.
strKey	[IN] Key value (node name), for example, using "Width" to get width.
pstIntValue	[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.

Examples

Grab_Asynchronous.cpp, HighBandwidthDecode.cpp, InterfaceDemo.cpp, and MultiLightCtrl_ImageStitching.cpp.

MV_CC_SetIntValueEx()

MV_CAMCTRL_API int __stdcall MV_CC_SetIntValueEx	(	IN void *	handle,
		IN const char *	strKey,
		IN int64_t	nValue
	)

Set the value of camera integer type node.

Parameters

handle	[IN] Device handle.
strKey	[IN] Key value (node name), for example, using "Width" to get width.
nValue	[IN] Node value.

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.

Examples

ChunkData.cpp, ConnectSpecCamera.cpp, Display.cpp, Events.cpp, Grab_Asynchronous.cpp, GrabImage.cpp, GrabImage_Callback.cpp, GrabImage_HighPerformance.cpp, GrabMultipleCamera.cpp, HighBandwidthDecode.cpp, ImageProcess.cpp, InterfaceAndDeviceDemo.cpp, InterfaceDemo.cpp, MultiCast.cpp, ParametrizeCamera_AreaScanIOSettings.cpp, ParametrizeCamera_LineScanIOSettings.cpp, ReconnectDemo.cpp, SetParam.cpp, Trigger_Image.cpp, and Trigger_ImageCallback.cpp.

MV_CC_GetEnumValue()

MV_CAMCTRL_API int __stdcall MV_CC_GetEnumValue	(	IN void *	handle,
		IN const char *	strKey,
		IN OUT MVCC_ENUMVALUE *	pstEnumValue
	)

Get the value of camera Enum type node.

Parameters

handle	[IN] Device handle.
strKey	[IN] Key value (node name), for example, using "PixelFormat" to get pixel format.
pstEnumValue	[IN][OUT] Structure pointer of camera features.

Returns

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

Note

After the device is connected, call this API to get specified Enum nodes.

Examples

InterfaceDemo.cpp, and SetParam.cpp.

MV_CC_GetEnumValueEx()

MV_CAMCTRL_API int __stdcall MV_CC_GetEnumValueEx	(	IN void *	handle,
		IN const char *	strKey,
		IN OUT MVCC_ENUMVALUE_EX *	pstEnumValue
	)

Get the value of camera Enum type node (extended API).

Parameters

handle	[IN] Device handle / frame grabber handle.
strKey	[IN] Key value (node name), for example, using "PixelFormat" to get pixel format.
pstEnumValue	[IN][OUT] Structure pointer of camera features.

Returns

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

Note

• After the device is connected, call this API to get specified Enum nodes.
• It max. supports 256 returned enumerations.

MV_CC_SetEnumValue()

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

Set the value of camera Enum type node.

Parameters

handle	[IN] Device handle.
strKey	[IN] Key value (node name), for example, using "PixelFormat" to set pixel format.
nValue	[IN] Node value.

Returns

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

Note

You can call this API to set specified Enum node after connecting the device.

Examples

ChunkData.cpp, ConnectSpecCamera.cpp, Events.cpp, Grab_Asynchronous.cpp, GrabImage.cpp, GrabImage_Callback.cpp, GrabImage_HighPerformance.cpp, GrabMultipleCamera.cpp, HighBandwidthDecode.cpp, ImageProcess.cpp, ImageSave.cpp, InterfaceAndDeviceDemo.cpp, InterfaceDemo.cpp, MultiLightCtrl_ImageStitching.cpp, ParametrizeCamera_LineScanIOSettings.cpp, QuickSoftwareTrigger.cpp, ReconnectDemo.cpp, SetParam.cpp, Trigger_Image.cpp, and Trigger_ImageCallback.cpp.

MV_CC_GetEnumEntrySymbolic()

MV_CAMCTRL_API int __stdcall MV_CC_GetEnumEntrySymbolic	(	IN void *	handle,
		IN const char *	strKey,
		IN OUT MVCC_ENUMENTRY *	pstEnumEntry
	)

Get the enumerator name according to the node name and assigned value.

Parameters

handle	[IN] Device handle.
strKey	[IN] Key value (node name), for example, using "PixelFormat" to set pixel format.
pstEnumEntry	[IN][OUT] The enumerator name.

Returns

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

Note

After connecting to the device, you can get the enumerator name according to the node name and assigned value.

Examples

InterfaceDemo.cpp.

MV_CC_SetEnumValueByString()

MV_CAMCTRL_API int __stdcall MV_CC_SetEnumValueByString	(	IN void *	handle,
		IN const char *	strKey,
		IN const char *	strValue
	)

Set the value of camera Enum type node.

Parameters

handle	[IN] Device handle.
strKey	[IN] Key value (node name), for example, using "PixelFormat" to set pixel format.
strValue	[IN] Camera property string to be set.

Returns

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

Note

You can call this API to set specified Enum node after connecting the device.

Examples

ChunkData.cpp, ParametrizeCamera_AreaScanIOSettings.cpp, and QuickSoftwareTrigger.cpp.

MV_CC_GetFloatValue()

MV_CAMCTRL_API int __stdcall MV_CC_GetFloatValue	(	IN void *	handle,
		IN const char *	strKey,
		IN OUT MVCC_FLOATVALUE *	pstFloatValue
	)

Get the value of camera float type node.

Parameters

handle	[IN] Device handle.
strKey	[IN] Key value (node name).
pstFloatValue	[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 specified float nodes after connecting the device.

Examples

InterfaceDemo.cpp, and SetParam.cpp.

MV_CC_SetFloatValue()

MV_CAMCTRL_API int __stdcall MV_CC_SetFloatValue	(	IN void *	handle,
		IN const char *	strKey,
		IN float	fValue
	)

Set the value of camera float type node.

Parameters

handle	[IN] Device handle.
strKey	[IN] Key value (node name).
fValue	[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 specified float node after connecting the device.

Examples

InterfaceDemo.cpp, ParametrizeCamera_AreaScanIOSettings.cpp, and SetParam.cpp.

MV_CC_GetBoolValue()

MV_CAMCTRL_API int __stdcall MV_CC_GetBoolValue	(	IN void *	handle,
		IN const char *	strKey,
		IN OUT bool *	pbValue
	)

Get the value of camera bool type node.

Parameters

handle	[IN] Device handle.
strKey	[IN] Key value (node name).
pbValue	[IN][OUT] Structure pointer of camera features.

Returns

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

Note

After the device is connected, call this API to get specified bool nodes.

Examples

InterfaceDemo.cpp, and SetParam.cpp.

MV_CC_SetBoolValue()

MV_CAMCTRL_API int __stdcall MV_CC_SetBoolValue	(	IN void *	handle,
		IN const char *	strKey,
		IN bool	bValue
	)

Set Boolean value.

Parameters

handle	[IN] Device handle.
strKey	[IN] Key value (node name).
bValue	[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 specified bool node after connecting the device.

Examples

ChunkData.cpp, Grab_Asynchronous.cpp, InterfaceDemo.cpp, ParametrizeCamera_AreaScanIOSettings.cpp, SetParam.cpp, Trigger_Image.cpp, and Trigger_ImageCallback.cpp.

MV_CC_GetStringValue()

MV_CAMCTRL_API int __stdcall MV_CC_GetStringValue	(	IN void *	handle,
		IN const char *	strKey,
		IN OUT MVCC_STRINGVALUE *	pstStringValue
	)

Get the value of camera string type node.

Parameters

handle	[IN] Device handle.
strKey	[IN] Key value (node name).
pstStringValue	[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 specified string node after connecting the device.

Examples

GrabMultipleCamera.cpp, InterfaceDemo.cpp, and SetParam.cpp.

MV_CC_SetStringValue()

MV_CAMCTRL_API int __stdcall MV_CC_SetStringValue	(	IN void *	handle,
		IN const char *	strKey,
		IN const char *	strValue
	)

Set the camera value of string type.

Parameters

handle	[IN] Device handle.
strKey	[IN] Key value (node name).
strValue	[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 specified string type node after connecting the device.

Examples

InterfaceDemo.cpp, and SetParam.cpp.

MV_CC_SetCommandValue()

MV_CAMCTRL_API int __stdcall MV_CC_SetCommandValue	(	IN void *	handle,
		IN const char *	strKey
	)

Set the camera Command node.

Parameters

handle	[IN] Device handle.
strKey	[IN] Key value (node name).

Returns

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

Note

You can call this API to set specified Command node after connecting the device.

Examples

QuickSoftwareTrigger.cpp, Trigger_Image.cpp, and Trigger_ImageCallback.cpp.

MV_CC_FeatureSave()

MV_CAMCTRL_API int __stdcall MV_CC_FeatureSave	(	IN void *	handle,
		IN const char *	strFileName
	)

Save camera feature.

Parameters

handle	[IN] Device handle.
strFileName	[IN] File name.

Returns

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

Examples

ParametrizeCamera_LoadAndSave.cpp.

MV_CC_FeatureLoad()

MV_CAMCTRL_API int __stdcall MV_CC_FeatureLoad	(	IN void *	handle,
		IN const char *	strFileName
	)

Import camera feature.

Parameters

handle	[IN] Device handle.
strFileName	[IN] File name.

Returns

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

Examples

ParametrizeCamera_LoadAndSave.cpp.

MV_CC_FeatureLoadEx()

MV_CAMCTRL_API int __stdcall MV_CC_FeatureLoadEx	(	IN void *	handle,
		IN const char *	strFileName,
		IN OUT MVCC_NODE_ERROR_LIST *	pstNodeErrorList
	)

Import camera feature with error message list.

Parameters

handle	[IN] Device handle / Frame grabber handle.
strFileName	[IN] File name.
pstNodeErrorList	[IN][OUT] Error message list, requested by the user externally and filled with data internally, this parameter allows null to indicate that the user is not concerned about error information during import.

Returns

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

Note

When some nodes fail to load, the interface returns MV_OK.
The error node and the reason for the failure are obtained through stNodeError in the error message list.