Back to Aurora Vision Library website

You are here: Start » Function Reference » Camera Support » ZebraCVCameras » ZebraCVCameras_GrabImage_WithTimeout

ZebraCVCameras_GrabImage_WithTimeout


Header: ThirdPartySdk.h
Namespace: avl
Module: ThirdParty

Captures an image using a ZebraCVCameras device with timeout.

Syntax

bool avl::ZebraCVCameras_GrabImage_WithTimeout
(
	ZebraCVCameras_State& ioState,
	atl::Optional<const atl::String&> inDeviceID,
	int inTimeout,
	int inInputQueueSize,
	atl::Optional<avl::EBUSPixelFormat::Type> inPixelFormat,
	atl::Optional<const avl::Box&> inAoi,
	atl::Optional<avl::EBUSAcquisitionMode::Type> inAcquisitionMode,
	atl::Optional<int> inAcquisitionFrameCount,
	atl::Optional<double> inFrameRate,
	atl::Optional<avl::EBUSAutoExposureMode::Type> inExposureAuto,
	atl::Optional<double> inExposureTime,
	atl::Optional<avl::EBUSAutoGainMode::Type> inGainAuto,
	atl::Optional<double> inGain,
	atl::Optional<avl::EBUSTriggerSource::Type> inTriggerSource,
	atl::Optional<avl::EBUSTriggerActivation::Type> inTriggerActivation,
	bool inSkipInvalidFrames,
	atl::Conditional<avl::Image>& outImage,
	atl::Conditional<avl::EBUSFrameData>& outFrameData
)

Parameters

Name Type Range Default Description
Input will be modified ioState ZebraCVCameras_State& Object used to maintain state of the function.
Input value inDeviceID Optional<const String&> NIL Device identifying number
Input value inTimeout int 100 - 100 Maximum time to wait for frame in milliseconds
Input value inInputQueueSize int 1 - 12 Capacity of output frames queue
Input value inPixelFormat Optional<EBUSPixelFormat::Type> NIL Image pixel format
Input value inAoi Optional<const Box&> NIL Area of interest
Input value inAcquisitionMode Optional<EBUSAcquisitionMode::Type> NIL Acquisition mode
Input value inAcquisitionFrameCount Optional<int> 1 - 65535 NIL Number of frames to acquire in MultiFrame acquisition mode
Input value inFrameRate Optional<double> 0.125 - NIL Acquisition frame rate
Input value inExposureAuto Optional<EBUSAutoExposureMode::Type> NIL Automatic exposure mode
Input value inExposureTime Optional<double> 1 - NIL Exposure time in us
Input value inGainAuto Optional<EBUSAutoGainMode::Type> NIL Automatic gain mode
Input value inGain Optional<double> 1 - NIL Gain as an absolute physical value
Input value inTriggerSource Optional<EBUSTriggerSource::Type> NIL Trigger source
Input value inTriggerActivation Optional<EBUSTriggerActivation::Type> NIL Trigger activation mode
Input value inSkipInvalidFrames bool True Skipping invalid images
Output value outImage Conditional<Image>& Captured frame
Output value outFrameData Conditional<EBUSFrameData>& Captured frame data

Remarks

Camera driver software

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

Please contact our technical support to obtain the SDK.

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, the first available camera will be found and connected.

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

  • Serial Number - should be printed on the device housing.
  • Device ID - unique device identifier.
  • IP Address - network IP address of device.
  • MAC Address - MAC address of device.

See Also