Back to Aurora Vision Library Lite website

You are here: Start » Camera Support » Microview » Microview_GrabImage

Microview_GrabImage


Header: ThirdPartySdk.h
Namespace: avl

Captures a frame using Microview.

Syntax

bool avl::Microview_GrabImage
(
	Microview_State& ioState,
	const atl::Optional<int> inDeviceID,
	int inInputQueueSize,
	bool inJumboFrameSupport,
	bool inRescanNeeded,
	const avl::MicroviewUsersSettingsParams& inUsersSettingsParams,
	const avl::MicroviewImageFormatParams& inImageFormat,
	const avl::MicroviewAcquisitionParams& inAcquisitionControl,
	const avl::MicroviewTriggerParams& inTriggerControl,
	avl::Image& outImage,
	int& outFrameId
)

Parameters

Name Type Range Default Description
Input will be modified ioState Microview_State& Object used to maintain state of the function.
Input value inDeviceID const Optional<int> 0 - 10000 NIL Device identifying number
Input value inInputQueueSize int 1 - 200 4 Capacity of output frames queue
Input value inJumboFrameSupport bool True
Input value inRescanNeeded bool
Input value inUsersSettingsParams const MicroviewUsersSettingsParams&
Input value inImageFormat const MicroviewImageFormatParams&
Input value inAcquisitionControl const MicroviewAcquisitionParams&
Input value inTriggerControl const MicroviewTriggerParams&
Output value outImage Image& Captured frame
Output value outFrameId int& Frame id

Remarks

Camera driver software

This filter is intended to cooperate with a camera using its vendor SDK. To be able to connect to a camera, it is required to install MVGESDK software with camera dedicated drivers.

MVGESDK can be downloaded from the following website: http://www.microview.com.cn (registration may be required).

Recommended MVGESDK version for Aurora Vision Studio usage is 2.8.

Add DLL path to system environment variable may be required.

Camera identification

When there is only one camera connected to a computer, field inDeviceID can be set to Auto. In this case, first available camera will be found and connected.

inDeviceID field can be used to pick one of multiple cameras connected to computer. DeviceID can be set to:

  • Device number - should be specified on device casing.
Camera parameters

Setting inJumboFrameSupport parameter to 'true' will select maximum possible camera package size.

Setting inRescanNeeded parameter to 'true' will rescan network to search new cameras.

All the other parameters exposed by camera filters are optional, setting them to 'Auto' leaves related parameter unchanged in camera (device default or user set configuration).

Multithreaded environment

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

See Also