Back to FabImage Library website

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

XiApi_StartAcquisition


Header: ThirdPartySdk.h
Namespace: fil
Module: ThirdParty

Initializes and starts image acquisition in a camera.

Syntax

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

Parameters

Name Type Range 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 inImageDataFormat XiApiImageDataFormat::Type Output data format
Input value inTriggerSource Optional<const XiApiTriggerSource::Type&> NIL Defines source of trigger
Input value inDownsampling Optional<const XiApiDownsampling::Type&> NIL Changes image resolution by binning or skipping
Input value inExposureTime Optional<int> 0 - + NIL Exposure time in microseconds
Input value inGain Optional<float> NIL Gain in dB
Input value inAoi Optional<const Box&> NIL Required fragment of image to stream
Input value inBadPixelCorrection Optional<bool> NIL Correction of bad pixels
Input value inAutomaticExposureGain Optional<bool> NIL Automatic exposure gain

Multithreaded environment

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