You are here: Start » Function Reference » Euresys » MultiCam_GrabImage_WithTimeout

MultiCam_GrabImage_WithTimeout

Header:	ThirdPartySdk.h
Namespace:	fil

Captures a frame using Euresys frame grabber.

Syntax

bool fil::MultiCam_GrabImage_WithTimeout
(
	MultiCam_State& ioState,
	ftl::Optional<ftl::String> inDeviceID,
	ftl::Optional<ftl::String> inTopology,
	ftl::Optional<int> inTimeout,
	ftl::Optional<ftl::String> inCameraTapConfiguration,
	const ftl::String& inConnector,
	fil::MultiCamAcquisitionMode::Type inAcquisitionMode,
	ftl::Optional<const ftl::File&> inCameraFile,
	ftl::Optional<int> inPageLengthLn,
	fil::MultiCamColorFormat::Type inColorFormat,
	ftl::Optional<int> inGain,
	ftl::Conditional<fil::Image>& outImage,
	ftl::Conditional<ftl::int64>& outFrameID,
	ftl::Conditional<ftl::int64>& outTimestamp
)

Parameters

Name	Type	Range	Default	Description
ioState	MultiCam_State&			Object used to maintain state of the function.
inDeviceID	Optional<String>		NIL	Board name, board identifier or serial number
inTopology	Optional<String>		NIL	Board topology
inTimeout	Optional<int>	10 -	NIL	Timeout in milliseconds.
inCameraTapConfiguration	Optional<String>		NIL	Tap configuration of camera
inConnector	const String&			Indication of connector used by channel
inAcquisitionMode	MultiCamAcquisitionMode::Type			Acquisition Mode
inCameraFile	Optional<const File&>		NIL	Camera configuration file
inPageLengthLn	Optional<int>	1 - 65535	NIL	Page Length
inColorFormat	MultiCamColorFormat::Type			Color format
inGain	Optional<int>		NIL	Linear control of gain for all digitizing units
outImage	Conditional<Image>&			Captured frame
outFrameID	Conditional<int64>&			Captured frame ID
outTimestamp	Conditional<int64>&			Captured frame timestamp in microseconds

Multithreaded environment

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