SynView_GrabImage_WithTimeout


Captures a frame using SynView; returns Nil if no frame comes in the specified time.

Applications:Use this filter if the trigger may be not coming for some time, while the application should be performing other operations continuously (e.g. processing HMI events).

Syntax

C++
Python
 
def SynView_GrabImage_WithTimeout(
	state: SynView_State,
	inImageFormatParams: SynViewImageFormatParams,
	/,
	*,
	inDeviceID: str | None = None,
	inInputQueueSize: int = 4,
	inColorFormat: SynViewColorFormat = SynViewColorFormat.Mono8,
	inTimeout: int = 5000,
	inAcquisitionParams: SynViewAcquisitionParams = SynViewAcquisitionParams(None, None, None, None, None),
	inAnalogParams: SynViewAnalogParams = SynViewAnalogParams(None, None, None)
)
-> (
	outResult: bool,
	outImage: Image | None,
	outFrameID: int | None,
	outTimestamp: int | None
)

Parameters

Name Type Range Default Description
Input will be modified ioState SynView_State
Input value inDeviceID str | None None Tries to find the camera in all available IDs (UserID, VendorName, ModelName...)
Input value inInputQueueSize int 1 - 4 Capacity of input frames queue
Input value inColorFormat SynViewColorFormat SynViewColorFormat.Mono8 Image color format
Input value inTimeout int 100 - 3600000 5000 Maximum time to wait for frame in milliseconds
Input value inAcquisitionParams SynViewAcquisitionParams SynViewAcquisitionParams(None, None, None, None, None)
Input value inImageFormatParams SynViewImageFormatParams
Input value inAnalogParams SynViewAnalogParams SynViewAnalogParams(None, None, None)
Output value outImage Image | None Captured frame
Output value outFrameID int | None Output frame number; 0 if not supported
Output value outTimestamp int | None Output image timestamp; 0 if not supported