Back to Aurora Vision Library website

You are here: Start » Function Reference » Camera Support » XIMEA » XiApi_GetParamFloat

XiApi_GetParamFloat

Header:	ThirdPartySdk.h
Namespace:	avl
Module:	ThirdParty

Gets parameter of type Float from XIMEA device.

Syntax

void avl::XiApi_GetParamFloat
(
	XIAPIState& ioState,
	const atl::Optional<atl::String>& inDeviceID,
	const atl::String& inParameter,
	float& outValue
)

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
	outValue	float&		Received value

Remarks

The value of the parameter is retrieved in every filter iteration.

The possible values (strings) of inParameter input can be found in the XIMEA documentation at the following 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_SetParamFloat – Sets parameter of type Float in XIMEA device.

XiApi_GetParamInt – Gets parameter of type Integer from XIMEA device.

XiApi_GenerateSoftwareTrigger – Generates software trigger for XIMEA device.