MultiCam_GrabImage_WithTimeout


Captures a frame using Euresys frame grabber.

Syntax

C++
Python
 
def MultiCam_GrabImage_WithTimeout(
	state: MultiCam_State,
	inConnector: str,
	/,
	*,
	inDeviceID: str | None = None,
	inTopology: str | None = None,
	inTimeout: int | None = None,
	inCameraTapConfiguration: str | None = None,
	inAcquisitionMode: MultiCamAcquisitionMode = MultiCamAcquisitionMode.SNAPSHOT,
	inCameraFile: str | None = None,
	inPageLengthLn: int | None = None,
	inColorFormat: MultiCamColorFormat = MultiCamColorFormat.Y8,
	inGain: int | None = None,
	inSurfaceCount: int | None = 3
)
-> (
	outResult: bool,
	outImage: Image | None,
	outFrameID: int | None,
	outTimestamp: int | None
)

Parameters

Name Type Range Default Description
Input will be modified ioState MultiCam_State
Input value inDeviceID str | None None Board name, board identifier or serial number
Input value inTopology str | None None Board topology
Input value inTimeout int | None 10 - None Timeout in milliseconds.
Input value inCameraTapConfiguration str | None None Tap configuration of camera
Input value inConnector str Indication of connector used by channel
Input value inAcquisitionMode MultiCamAcquisitionMode MultiCamAcquisitionMode.SNAPSHOT Acquisition Mode
Input value inCameraFile str | None None Camera configuration file
Input value inPageLengthLn int | None 1 - 65535 None Page Length
Input value inColorFormat MultiCamColorFormat MultiCamColorFormat.Y8 Color format
Input value inGain int | None None Linear control of gain for all digitizing units
Input value inSurfaceCount int | None 1 - 4096 3 Number of allocated surfaces
Output value outImage Image | None Captured frame
Output value outFrameID int | None Captured frame ID
Output value outTimestamp int | None Captured frame timestamp in microseconds

Multithreaded environment

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