Back to Aurora Vision Library website

You are here: Start » Function Reference » Camera Support » cxCam » cxCam_GrabData_WithTimeout

cxCam_GrabData_WithTimeout


Header: ThirdPartySdk.h
Namespace: avl
Module: ThirdParty

Captures a frame using cxCam Support Package with timeout.

Syntax

bool avl::cxCam_GrabData_WithTimeout
(
	cxCam_State& ioState,
	atl::Optional<const atl::String&> inDeviceID,
	int inInputQueueSize,
	int inTimeout,
	atl::Optional<const avl::CxCamModeAndAlgorithmConfiguration&> inModeAndAlgorithm,
	atl::Optional<const avl::CxCamC6ComponentSelector&> inC6ComponentSelector,
	avl::CxCamImagePixel::Type inPixel,
	avl::CxCamScannerMode::Type inScannerMode,
	avl::CxCamAcquisitionMode::Type inAcquisitionMode,
	atl::Optional<avl::CxCamTriggerMode::Type> inTriggerMode,
	atl::Optional<avl::CxCamTriggerSequencerMode::Type> inSequencerMode,
	const atl::Array<avl::CxCamC6TriggerSetup>& inC6TriggerSetup,
	atl::Conditional<atl::Array<avl::CxCamAOIOutput>>& outAOI
)

Parameters

Name Type Range Default Description
Input will be modified ioState cxCam_State& Object used to maintain state of the function.
Input value inDeviceID Optional<const String&> NIL Device URI.
Input value inInputQueueSize int 3 - 200 4 Capacity of output frames queue
Input value inTimeout int 1 - 100 Maximum time to wait for frame in milliseconds.
Input value inModeAndAlgorithm Optional<const CxCamModeAndAlgorithmConfiguration&> NIL 3D algorithm configuration.
Input value inC6ComponentSelector Optional<const CxCamC6ComponentSelector&> NIL Component selector for C6 family.
Input value inPixel CxCamImagePixel::Type Output pixel type.
Input value inScannerMode CxCamScannerMode::Type Scanner mode.
Input value inAcquisitionMode CxCamAcquisitionMode::Type AcquisitionMode.
Input value inTriggerMode Optional<CxCamTriggerMode::Type> NIL Trigger mode.
Input value inSequencerMode Optional<CxCamTriggerSequencerMode::Type> NIL Trigger sequencer mode.
Input value inC6TriggerSetup const Array<CxCamC6TriggerSetup>& Trigger setup for C6 family.
Output value outAOI Conditional<Array<CxCamAOIOutput>>& Output data. Usually one item.

Remarks

Camera driver software

This filter is intended to cooperate with a camera using its vendor SDK. To be able to connect to a camera, it is required to install AT SolutionPackage Software (previously known as cxCam Support Package) with camera dedicated drivers.

Package can be downloaded from the following website: https://www.at-sensors.com/product-support/downloads/ (registration may be required).

It may also be required to install GigE Vision Transport Layer as described here.

Add DLL path to system environment variable may be required. The SDK is divided into several directories with shared libraries - you have to add them all.

You should install the transport layer from Common Vision Box Runtime. The lack of this component may cause the application to behave unexpectedly.

Installing special network transport transport layer from vendor may be required.

Recommended AT SolutionPackage Software version for Aurora Vision Studio usage is 2023.12.

32-bit platform is not supported.

Camera identification

When there is only one camera connected to a computer, field inDeviceID can be set to Auto. In this case, first available camera will be found and connected.

inDeviceID field can be used to pick one of multiple cameras connected to computer. DeviceID can be set to:

  • URI - should be specified on device casing.
Camera parameters

Setting inInputQueueSize parameter to 'Auto' will select four value as input queue size.

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).

To change other, more advanced camera parameters, use specific filters.

See Also