Back to FabImage Library website
You are here: Start » Function Reference » Camera Support » XIMEA » XiApi_SetParamFloat
XiApi_SetParamFloat
| Header: | ThirdPartySdk.h |
|---|---|
| Namespace: | fil |
| Module: | ThirdParty |
Sets parameter of type Float in XIMEA device.
Syntax
void fil::XiApi_SetParamFloat ( XIAPIState& ioState, const ftl::Optional<ftl::String>& inDeviceID, const ftl::String& inParameter, float inValue )
Parameters
| Name | Type | Default | Description | |
|---|---|---|---|---|
 |
ioState | XIAPIState& | Object used to maintain state of the function. | |
 |
inDeviceID | const Optional<String>& | NIL | Camera chip ID or camera index |
|
inParameter | const String& | Parameter name | |
|
inValue | float | Value to set |
Remarks
The value of the parameter is set in every filter iteration. Please note, that if you set some parameter value in this filter you should not modify it by XiApi_GrabImage filter - it may cause problems.
The possible values (strings) of inParameter input can be found in the XIMEA documentation at the following website .
The full description of camera parameters can be found at the XIMEA website .
Multithreaded environment
This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.
See Also
- XiApi_GrabImage – Captures an image from a XIMEA camera.
- XiApi_SetGPIMode – Defines selected GPI (digital input) functionality.
- XiApi_GetGPILevel – Returns the value from selected GPI (digital input).
- XiApi_SetGPOMode – Defines GPO (digital output) functionality.
- XiApi_SetParamInt – Sets parameter of type Integer in XIMEA device.
- XiApi_GetParamInt – Gets parameter of type Integer from XIMEA device.
- XiApi_GetParamFloat – Gets parameter of type Float from XIMEA device.
- XiApi_GenerateSoftwareTrigger – Generates software trigger for XIMEA device.
