Smart_GrabImage_Roseek

Header:	ThirdPartySdk.h
Namespace:	avl

Captures an image from a smart camera using Roseek interface. Allows for remote access to the runtime system.

Syntax

bool avl::Smart_GrabImage_Roseek
(
	Smart_State& ioState,
	const avl::SmartIPAddress& inIpAddress,
	avl::RoseekImageFormat::Type inPixelFormat,
	atl::Optional<float> inFrameRate,
	atl::Optional<avl::RoseekWorkingMode::Type> inWorkingMode,
	atl::Optional<int> inSensitivityLevel,
	atl::Optional<avl::RoseekExposureMode::Type> inExposureMode,
	atl::Optional<int> inExposureTime,
	atl::Optional<float> inGain,
	avl::Image& outImage,
	bool& outIsRemote
)

Parameters

Name	Type	Range	Default	Description
ioState	Smart_State&			Object used to maintain state of the function.
inIpAddress	const SmartIPAddress&			IP address of the runtime system (e.g. a smart camera)
inPixelFormat	RoseekImageFormat::Type			Image color format
inFrameRate	Optional<float>		NIL	Requested camera frame rate in frames per second
inWorkingMode	Optional<RoseekWorkingMode::Type>		NIL	Working mode of image acquisition
inSensitivityLevel	Optional<int>	0 - 3	NIL	Sensitivity level of camera sensor
inExposureMode	Optional<RoseekExposureMode::Type>		NIL	Exposure mode, should be set to Manual if you want to adjust inExposureTime manually
inExposureTime	Optional<int>	0 -	NIL	Camera frame exposition time
inGain	Optional<float>	0.0 - 36.0	NIL	Camera exposure gain
outImage	Image&			Captured frame
outIsRemote	bool&

Multithreaded environment

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

Errors

List of possible exceptions:

Error type	Description
RuntimeError	Smart_GrabImage_Roseek is not supported in the Lite edition.