You are here: Start » Function Reference » XIMEA » XiApi_StartAcquisition

XiApi_StartAcquisition

Initializes and starts image acquisition in a camera.

Syntax

void avl::XiApi_StartAcquisition
(
	XIAPIState& ioState,
	const atl::Optional<atl::String>& inDeviceID,
	avl::XiApiImageDataFormat::Type inImageDataFormat,
	avl::XiApiTriggerSource::Type inTriggerSource,
	avl::XiApiDownsampling::Type inDownsampling,
	atl::Optional<int> inExposureTime,
	atl::Optional<float> inGain,
	atl::Optional<const avl::Box&> inAoi,
	atl::Optional<bool> inBadPixelCorrection,
	atl::Optional<bool> inAutomaticExposureGain
)

Parameters

	Name	Type	Range	Default	Description
	ioState	XIAPIState&			Object used to maintain state of the function.
	inDeviceID	const Optional<String>&		NIL	Camera chip ID or camera index
	inImageDataFormat	XiApiImageDataFormat::Type			Output data format
	inTriggerSource	XiApiTriggerSource::Type			Defines source of trigger
	inDownsampling	XiApiDownsampling::Type			Changes image resolution by binning or skipping
	inExposureTime	Optional<int>	0 - +	NIL	Exposure time in microseconds
	inGain	Optional<float>		NIL	Gain in dB
	inAoi	Optional<const Box&>		NIL	Required fragment of image to stream
	inBadPixelCorrection	Optional<bool>		NIL	Correction of bad pixels
	inAutomaticExposureGain	Optional<bool>		NIL	Automatic exposure gain

Multithreaded environment