MdigControlFeature

Board	Supported
Host System	No
V4L2	Partial
Clarity UHD	No
Concord PoE	No
GenTL	Yes
GevIQ	Partial
GigE Vision	Partial
Indio	No
Iris GTX	No
Radient eV-CL	Partial
Rapixo CL	Partial
Rapixo CoF	Partial
Rapixo CXP	Partial
USB3 Vision	Partial

Controls a feature of the camera.

Syntax

void MdigControlFeature(
    AIL_ID             DigId,        //out
    AIL_INT64          ControlType,  //in
    AIL_CONST_TEXT_PTR FeatureName,  //in
    AIL_INT64          UserVarType,  //in
    const void *       UserVarPtr    //in
)

Description

This function allows you to directly control various GenICam standard feature naming convention (SFNC) features and manufacturer-specific features of the camera. For more information, refer to Using Aurora Imaging Library with GenICam.

The features described in this function are primarily available to set existing settings using Aurora Imaging Library code or to set information from which you can build your own interface for the camera device's description file (XML). Aurora Imaging Library provides two versions of an interface that you can use to interactively inquire the camera's features. At design-time, you can use Aurora Imaging Intellicam's Feature Browser. At runtime, you can launch the Feature Browser, using MdigControl with M_GC_FEATURE_BROWSER. Both versions of the Feature Browser provide a list of available feature names and associated possible values, as well as code snippets with the Aurora Imaging Library functions and Aurora Imaging Library constants associated with the settings selected; you can copy the code snippets to your Aurora Imaging Library application code.

To inquire a camera's manufacturer-specific feature, use MdigInquireFeature.

System specific

Board(s)	Note
Radient eV-CL, Rapixo CL	For Camera Link boards to work with this function, you must first configure and enable the GenICam CLProtocol module, using MdigControl with M_GC_CLPROTOCOL. Note that this control type is only available after the required third-party vendor-supplied, standard compliant, CLProtocol library for your Camera Link camera is installed on your computer and M_GC_CLPROTOCOL_DEVICE_ID is set.

Parameters

DigId (out, AIL_ID)

Specifies the identifier of the digitizer accessing the camera to control. This parameter must be given a valid digitizer identifier, previously allocated using MdigAlloc.

ControlType (in, AIL_INT64)

Specifies the type of information to control for the specified feature.

FeatureName (in, AIL_CONST_TEXT_PTR)

Specifies the name of the camera feature to control.

For specifying the name of the feature

Value	Description
"FeatureName"	Specifies the name of the feature. Note that the feature name is case-sensitive.

Refer to your camera's documentation for a list of the features available. |

UserVarType (in, AIL_INT64)

Specifies the data type of the address pointed to by the UserVarPtrparameter. If not setting the feature's value (using M_FEATURE_VALUE), set this parameter to M_DEFAULT.

For specifying the UserVarPtr's data type

Value	Description
M_TYPE_BOOLEAN	Specifies that UserVarPtr is passed an address of type_AIL_BOOL_.
M_TYPE_DOUBLE	Specifies that UserVarPtr is passed an address of type AIL_DOUBLE.
M_TYPE_INT64	Specifies that UserVarPtr is passed an address of type AIL_INT64.
M_TYPE_STRING	Specifies that UserVarPtr is passed an address of type AIL_TEXT_CHAR.
M_TYPE_UINT8	Specifies that UserVarPtr is passed an address of type AIL_UINT8.

For specifying the length of the array

Value	Description
M_FEATURE_USER_ARRAY_SIZE	Specifies the length of the array.

UserVarPtr *(in, void)

Specifies the address of the variable in which to write the value of the feature.

Parameter Associations

For specifying the type of information about the feature to set and the data type returned

To determine the data type of the FeatureNamespecified, use MdigInquireFeature with M_FEATURE_VALUE.

---

M_FEATURE_CHANGE_HOOK

Board availability: GenTL, GevIQ, GigE Vision, USB3 Vision, V4L2

Sets whether to enable an event to occur when the value of the specified feature changes. Once enabled, use MdigHookFunction with M_FEATURE_CHANGE to hook a specified function to the feature change event. Repeat for each feature that you want to enable a feature change event. Alternatively, to enable an event to occur when the value of any feature changes and at the same time hook a function to any feature change, use MdigHookFunction with M_FEATURE_CHANGE + M_ALL.

Value	Description
M_DISABLE (default)	Specifies that no event is generated when the value of the specified feature changes.
M_ENABLE	Specifies that an event is generated when the value of the specified feature changes.

---

M_FEATURE_EXECUTE

Sets that the specified command feature must be executed.

---

M_FEATURE_MAX

Specifies to set the feature to its maximum value.

---

M_FEATURE_MIN

Specifies to set the feature to its minimum value.

---

M_FEATURE_VALUE

Sets the current value of the feature.

Combination Constants — For specifying the configuration file associated with the feature

Optional.

Usage: You can add one of the following values to the above-mentioned values to specify the GenTL configuration file (XML file) that is associated with the feature.

Board availability: GenTL

Value	Description
M_GENTL_STREAM_NUMBER	Specifies the feature is associated with an instance of the GenTL stream configuration information.
M_GENTL_DEVICE	Specifies that the feature is associated with the GenTL device configuration information.
M_GENTL_REMOTE_DEVICE (default)	Specifies that the feature is associated with the GenTL remote device configuration information.