cxCam_GrabData_WithTimeout


Captures a frame using cxCam Support Package with timeout.

Syntax

C++
Python
 
def cxCam_GrabData_WithTimeout(
	state: CxCam_State,
	inTimeout: int,
	inC6TriggerSetup: list[CxCamC6TriggerSetup],
	/,
	*,
	inDeviceID: str | None = None,
	inInputQueueSize: int = 4,
	inModeAndAlgorithm: CxCamModeAndAlgorithmConfiguration | None = None,
	inC6ComponentSelector: CxCamC6ComponentSelector | None = None,
	inPixel: CxCamImagePixel = CxCamImagePixel.Mono8,
	inScannerMode: CxCamScannerMode = CxCamScannerMode.Area,
	inAcquisitionMode: CxCamAcquisitionMode = CxCamAcquisitionMode.Continuous,
	inTriggerMode: CxCamTriggerMode | None = None,
	inSequencerMode: CxCamTriggerSequencerMode | None = None
)
-> (
	outResult: bool,
	outAOI: list[CxCamAOIOutput] | None
)

Parameters

Name Type Range Default Description
Input will be modified ioState CxCam_State
Input value inDeviceID str | None None Device URI.
Input value inInputQueueSize int 3 - 200 4 Capacity of output frames queue
Input value inTimeout int 1 - Maximum time to wait for frame in milliseconds.
Input value inModeAndAlgorithm CxCamModeAndAlgorithmConfiguration | None None 3D algorithm configuration.
Input value inC6ComponentSelector CxCamC6ComponentSelector | None None Component selector for C6 family.
Input value inPixel CxCamImagePixel CxCamImagePixel.Mono8 Output pixel type.
Input value inScannerMode CxCamScannerMode CxCamScannerMode.Area Scanner mode.
Input value inAcquisitionMode CxCamAcquisitionMode CxCamAcquisitionMode.Continuous AcquisitionMode.
Input value inTriggerMode CxCamTriggerMode | None None Trigger mode.
Input value inSequencerMode CxCamTriggerSequencerMode | None None Trigger sequencer mode.
Input value inC6TriggerSetup list[CxCamC6TriggerSetup] Trigger setup for C6 family.
Output value outAOI list[CxCamAOIOutput] | None Output data. Usually one item.