You are here: Start » Function Reference » Camera Support » NET SynView » SynView_GrabImage_WithTimeout

SynView_GrabImage_WithTimeout

Header:	ThirdPartySdk.h
Namespace:	fil
Module:	ThirdParty

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

bool fil::SynView_GrabImage_WithTimeout
(
	SynView_State& ioState,
	ftl::Optional<const ftl::String&> inDeviceID,
	int inInputQueueSize,
	fil::SynViewColorFormat::Type inColorFormat,
	int inTimeout,
	const fil::SynViewAcquisitionParams& inAcquisitionParams,
	const fil::SynViewImageFormatParams& inImageFormatParams,
	const fil::SynViewAnalogParams& inAnalogParams,
	ftl::Conditional<fil::Image>& outImage,
	ftl::Conditional<ftl::int64>& outFrameID,
	ftl::Conditional<ftl::int64>& outTimestamp
)

Parameters

Name	Type	Range	Default	Description
ioState	SynView_State&			Object used to maintain state of the function.
inDeviceID	Optional<const String&>		NIL	Tries to find the camera in all available IDs (UserID, VendorName, ModelName...)
inInputQueueSize	int	1 -	4	Capacity of input frames queue
inColorFormat	SynViewColorFormat::Type			Image color format
inTimeout	int	100 - 3600000	5000	Maximum time to wait for frame in milliseconds
inAcquisitionParams	const SynViewAcquisitionParams&
inImageFormatParams	const SynViewImageFormatParams&
inAnalogParams	const SynViewAnalogParams&
outImage	Conditional<Image>&			Captured frame
outFrameID	Conditional<int64>&			Output frame number; 0 if not supported
outTimestamp	Conditional<int64>&			Output image timestamp; 0 if not supported