SynView_GrabImage


Captures a frame using SynView.

Syntax

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

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 inAcquisitionParams SynViewAcquisitionParams SynViewAcquisitionParams(None, None, None, None, None)
Input value inImageFormatParams SynViewImageFormatParams
Input value inAnalogParams SynViewAnalogParams SynViewAnalogParams(None, None, None)
Output value outImage Image Captured frame
Output value outFrameID int Output frame number; 0 if not supported
Output value outTimestamp int Output image timestamp; 0 if not supported