Back to Adaptive Vision Library website

You are here: Start » Function Reference » Gocator » Gocator_GrabImages_WithTimeout

Gocator_GrabImages_WithTimeout


Header:ThirdPartySdk.h
Namespace:avl

Captures images from Gocator device.

Syntax

bool avl::Gocator_GrabImages_WithTimeout
(
	Gocator_State& ioState,
	const atl::Optional<avl::GocatorAddress>& inAddress,
	int inInputQueueSize,
	int inTimeout,
	atl::Conditional<avl::Image>& outImage1,
	atl::Conditional<avl::Image>& outImage2,
	atl::Conditional<avl::GocatorFrameInfo>& outFrameInfo
)

Parameters

Name Type Range Default Description
ioState Gocator_State& Object used to maintain state of the function.
inAddress const Optional<GocatorAddress>& NIL Gocator Device identifying IP address (e.g. "127.0.0.1") or serial number (e.g. "SN:17335")
inInputQueueSize int 1 - 200 Number of incoming frames that can be buffered before the application is able to process them
inTimeout int 10 - 100 Maximum time to wait for data in milliseconds
outImage1 Conditional<Image>& First output image
outImage2 Conditional<Image>& Second output image
outFrameInfo Conditional<GocatorFrameInfo>&

Remarks

Device identification

When there is only one device connected, the field inAddress can be set to Auto. In this situation, the first available device will be used.

inAddress can be used to pick one of multiple devices connected to the computer. inAddress can be set to:

  • IP Address - Gocator Device identifying IP address (e.g. "127.0.0.1")
  • Serial Number - Gocator Device serial number with "SN:" prefix (e.g. "SN:17335")
Gocator emulator

This filter was tested with Gocator emulator in version 5.2.19.71.

Multithreaded environment

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

See Also