Back to Aurora Vision Library Lite website

You are here: Start » Hardware Support » Euresys » MultiCam_GrabImage

MultiCam_GrabImage


Header: ThirdPartySdk.h
Namespace: avl

Captures a frame using Euresys frame grabber.

Syntax

bool avl::MultiCam_GrabImage
(
	MultiCam_State& ioState,
	atl::Optional<atl::String> inDeviceID,
	atl::Optional<atl::String> inTopology,
	atl::Optional<atl::String> inCameraTapConfiguration,
	const atl::String& inConnector,
	avl::MultiCamAcquisitionMode::Type inAcquisitionMode,
	atl::Optional<const atl::File&> inCameraFile,
	atl::Optional<int> inPageLengthLn,
	avl::MultiCamColorFormat::Type inColorFormat,
	atl::Optional<int> inGain,
	atl::Optional<int> inSurfaceCount,
	avl::Image& outImage,
	atl::int64& outFrameID,
	atl::int64& outTimestamp
)

Parameters

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

Remarks

Board driver software

This filter is intended to cooperate with board using its vendor SDK. To be able to connect with board it is required to install MultiCam SDK software. Currently Aurora Vision Studio requires MultiCam version 6.18.

MultiCam drivers can be downloaded from following website: https://www.euresys.com (registration may be required).

Supported frame grabbers:
  • GRABLINK series
  • DOMINO series
  • Picolo series
Board identification

When there is only one board connected to the computer, field inDeviceID can be set to Auto. In such case, first available board will be found and connected.

inDeviceID can be used to pick one of multiple boards connected to the computer. inDeviceID can be set to:

  • board name,
  • board identifier,
  • driver index,
  • pci position.

Multithreaded environment

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

See Also