GenICam_SDK.docx
15
4.3 Getting and setting device parameters
It is possible to retrieve and set parameters on the device/camera. The SDK additionally
provides the possibility to set parameters for other involved components such as the transport
layer module.
Therefore, it is possible to indicate this by changing the module parameter from the default
setting (CSI_DEVICE_MODULE) to the other components such as transport layer, stream, or
buffer module.
Please note that the parameters available for the different modules will differ significantly!
csiGetFeatureBool
Retrieve a boolean feature from the device
Syntax
csiErr csiGetFeatureBool (csiHandle device, const char* parameterName, bool* valueOut,
csiModuleLevel module = CSI_DEVICE_MODULE)
Parameters:
In: device: Handle provided by the
csiOpenDevice
-function
parameterName: name of the feature to get (Not the display name!)
module: Module for which the parameter should be get. Please use the enum csiModuleLevel to select.
Determines if the parameter should be retrieved from the device-, transport layer-, interface- stream- or buffer-
module
Out:
valueOut: Pointer to a bool-value where the current value of the feature will be written to
Return value:
Returns csiSuccess or an error defined in the csiErr-Enum.
Comment:
csiSetFeatureBool
Set a boolean feature on the device
Syntax
csiErr csiSetFeatureBool(csiHandle device, const char* parameterName, bool value,
csiModuleLevel module = CSI_DEVICE_MODULE)
Parameters:
In: device: Handle provided by the
csiOpenDevice
-function
parameterName: name (Not the display name!) of the feature to set
value: Boolean value to set the feature to (true or false)
module: Module for which the parameter should be set. Please use the enum csiModuleLevel to select.
Determines if the parameter should be set on the device-, transport layer-, interface- stream- or buffer-
module
Out:
Return value:
Returns csiSuccess or an error defined in the csiErr-Enum.
Comment:
csiGetFeatureInt
Retrieve an integer feature from the device
Syntax
csiErr csiGetFeatureInt(csiHandle device, const char* parameterName, int64_t* valueOut,
csiModuleLevel module = CSI_DEVICE_MODULE)
Parameters:
In: device: Handle provided by the
csiOpenDevice
-function
parameterName: name (Not the display name!) of the feature to get
module: Module for which the parameter should be get. Please use the enum csiModuleLevel to select.
Determines if the parameter should be retrieved from the device-, transport layer-, interface- stream- or buffer-
module
Out:
valueOut: Pointer to an in64_t-value where the current value of the feature will be written to
Return value:
Returns csiSuccess or an error defined in the csiErr-Enum.
Comment:
