Back to Aurora Vision Library Lite website

You are here: Start » Camera Support » XSightSmartCamera » XSightSmartCamera_StartAcquisition

XSightSmartCamera_StartAcquisition


Header: ThirdPartySdk.h
Namespace: avl

Starts image acquisition.

Syntax

C++
Python
 
void avl::XSightSmartCamera_StartAcquisition
(
	XSightSmartCamera_State& ioState,
	atl::Optional<int> inDeviceIndex,
	int inInputQueueSize,
	atl::Optional<const avl::XSightSmartCameraImageFormat&> inImageFormat,
	atl::Optional<int> inExposureTime,
	atl::Optional<int> inFrameRate,
	atl::Optional<bool> inGainAuto,
	atl::Optional<const atl::Array<int>&> inGain,
	atl::Optional<int> inBlackLevel,
	atl::Optional<bool> inWhiteBalanceAuto,
	atl::Optional<int> inContrast,
	atl::Optional<int> inGamma,
	atl::Optional<int> inLumination,
	atl::Optional<int> inSaturation,
	atl::Optional<int> inHUE,
	atl::Optional<int> inColorCorrection,
	atl::Optional<int> inSharpness,
	atl::Optional<bool> inTriggerMode,
	atl::Optional<const avl::XSightSmartCameraTriggerConfiguration&> inTriggerConfiguration
)

Parameters

Name Type Range Default Description
Input will be modified ioState XSightSmartCamera_State& Object used to maintain state of the function.
Input value inDeviceIndex Optional<int> 0 - NIL Device identifying number
Input value inInputQueueSize int 1 - 5 Capacity of output frames queue
Input value inImageFormat Optional<const XSightSmartCameraImageFormat&> NIL
Input value inExposureTime Optional<int> 1 - NIL Exposure time in milliseconds
Input value inFrameRate Optional<int> 1 - NIL
Input value inGainAuto Optional<bool> NIL
Input value inGain Optional<const Array<int>&> NIL
Input value inBlackLevel Optional<int> 1 - NIL
Input value inWhiteBalanceAuto Optional<bool> NIL
Input value inContrast Optional<int> 1 - 128 NIL
Input value inGamma Optional<int> 0 - NIL
Input value inLumination Optional<int> 1 - 128 NIL
Input value inSaturation Optional<int> 1 - NIL
Input value inHUE Optional<int> 1 - NIL
Input value inColorCorrection Optional<int> 1 - NIL
Input value inSharpness Optional<int> 1 - NIL
Input value inTriggerMode Optional<bool> NIL
Input value inTriggerConfiguration Optional<const XSightSmartCameraTriggerConfiguration&> NIL

Remarks

Camera driver software

inDeviceIndex can be used to pick one of multiple devices connected to the computer. inDeviceIndex can be set to:

  • Device Index - X-Sight smart camera identifying internal index.

Camera device driver software

This filter is intended to cooperate with a device using its vendor SDK. To be able to connect to a device, it is required to install X-Sight smart camera SDK.

Add DLL path to system environment variable is required.

Recommended Runtime version for Aurora Vision Studio usage is 1.0.

All the other parameters exposed by camera filters are optional, setting them to 'Auto' leaves related parameter unchanged in camera (device default or user set configuration).

Warning:All tools applied to a specific device or file should be managed within a single thread to ensure centralized tracking, traceability, and consistency throughout the process.

See Also