Back to Aurora Vision Library website

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

SynView_GrabImage_WithTimeout


Header: ThirdPartySdk.h
Namespace: avl
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 avl::SynView_GrabImage_WithTimeout
(
	SynView_State& ioState,
	atl::Optional<const atl::String&> inDeviceID,
	int inInputQueueSize,
	avl::SynViewColorFormat::Type inColorFormat,
	int inTimeout,
	const avl::SynViewAcquisitionParams& inAcquisitionParams,
	const avl::SynViewImageFormatParams& inImageFormatParams,
	const avl::SynViewAnalogParams& inAnalogParams,
	atl::Conditional<avl::Image>& outImage,
	atl::Conditional<atl::int64>& outFrameID,
	atl::Conditional<atl::int64>& outTimestamp
)

Parameters

Name Type Range Default Description
Input will be modified ioState SynView_State& Object used to maintain state of the function.
Input value inDeviceID Optional<const String&> NIL 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::Type Image color format
Input value inTimeout int 100 - 3600000 5000 Maximum time to wait for frame in milliseconds
Input value inAcquisitionParams const SynViewAcquisitionParams&
Input value inImageFormatParams const SynViewImageFormatParams&
Input value inAnalogParams const SynViewAnalogParams&
Output value outImage Conditional<Image>& Captured frame
Output value outFrameID Conditional<int64>& Output frame number; 0 if not supported
Output value outTimestamp Conditional<int64>& Output image timestamp; 0 if not supported