Back to Aurora Vision Library website

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

XiApi_SetParamInt


Header: ThirdPartySdk.h
Namespace: avl
Module: ThirdParty

Sets parameter of type Integer in XIMEA device.

Syntax

void avl::XiApi_SetParamInt
(
	XIAPIState& ioState,
	const atl::Optional<atl::String>& inDeviceID,
	const atl::String& inParameter,
	int inValue
)

Parameters

Name Type Default Description
Input will be modified ioState XIAPIState& Object used to maintain state of the function.
Input value inDeviceID const Optional<String>& NIL Camera chip ID or camera index
Input value inParameter const String& Parameter name
Input value inValue int 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 .

Multithreaded environment

This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.

See Also