Back to Aurora Vision Library Lite website

You are here: Start » Camera Support » Gocator » Gocator_GrabSurface

Gocator_GrabSurface


Header: ThirdPartySdk.h
Namespace: avl

Captures Surface from Gocator device.

Syntax

bool avl::Gocator_GrabSurface
(
	Gocator_State& ioState,
	const atl::Optional<avl::GocatorAddress>& inAddress,
	int inInputQueueSize,
	avl::Surface& outSurface,
	atl::Conditional<avl::Image>& outSurfaceIntensity,
	avl::GocatorFrameInfo& outFrameInfo
)

Parameters

Name Type Range Default Description
Input will be modified ioState Gocator_State& Object used to maintain state of the function.
Input value inAddress const Optional<GocatorAddress>& NIL Gocator Device identifying IP address (e.g. "127.0.0.1") or serial number (e.g. "SN:17335")
Input value inInputQueueSize int 1 - 50000 Number of incoming frames that can be buffered before the application is able to process them
Output value outSurface Surface&
Output value outSurfaceIntensity Conditional<Image>&
Output value outFrameInfo 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 6.1.20.8.

See Also