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

SynView_GrabImage_WithTimeout

Header:	ThirdPartySdk.h
Namespace:	fil

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

Syntax

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

Parameters

Name	Type	Range	Default	Description
ioState	SynView_GrabImage_WithTimeoutState&			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...)
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

Multithreaded environment

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