Back to Adaptive Vision Library website

You are here: Start » Function Reference » Allied Vision Technologies » PvAPI_GrabImage_Deprecated

PvAPI_GrabImage_Deprecated


Captures a frame from Allied Vision cameras using PvAPI.

Syntax

bool avl::PvAPI_GrabImage_Deprecated
(
	PvAPI_GrabImage_DeprecatedState& ioState,
	atl::Optional<const atl::String&> inDeviceID,
	atl::Optional<avl::Box> inAoi,
	avl::PvAPIPixelFormat::Type inPixelFormat,
	atl::Optional<int> inTimeout,
	atl::Optional<int> inGain,
	atl::Optional<int> inFrameRate,
	atl::Optional<int> inExposureTime,
	atl::Optional<int> inWhiteBalanceRed,
	atl::Optional<int> inWhiteBalanceBlue,
	avl::Image& outImage
)

Parameters

Name Type Range Default Description
ioState PvAPI_GrabImage_DeprecatedState& Object used to maintain state of the function.
inDeviceID Optional<const String&> NIL IP address, camera name, model name, part number or serial number of device to be opened
inAoi Optional<Box> NIL Required fragment of image to stream
inPixelFormat PvAPIPixelFormat::Type Requested pixel format
inTimeout Optional<int> NIL Maximum wait time for camera frame
inGain Optional<int> 0 - + NIL Gain
inFrameRate Optional<int> 1 - + NIL Frame rate
inExposureTime Optional<int> 0 - + NIL Camera frame exposition time
inWhiteBalanceRed Optional<int> NIL White balance red parameter
inWhiteBalanceBlue Optional<int> NIL White balance blue parameter
outImage Image& Captured frame

Remarks

Camera driver software

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

PvAPI SDK can be downloaded from following website: www.alliedvisiontec.com.

Recommended PvAPI SDK version for Adaptive Vision Studio usage is 1.2.6.

Camera identification

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

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

  • Serial number - camera's serial number.
  • Part number - manufacturer's part number.
  • Camera name - human-friendly camera name.
  • Model name - name of the camera part

Multithreaded environment

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