Back to FabImage Library website

You are here: Start » Function Reference » Camera Support » ZebraScanEngines » ZebraScanEngines_GrabImage

ZebraScanEngines_GrabImage


Header: ThirdPartySdk.h
Namespace: fil
Module: ThirdParty

Captures a frame using a Zebra scanner.

Syntax

bool fil::ZebraScanEngines_GrabImage
(
	ZebraScanEngines_State& ioState,
	ftl::Optional<int> inDeviceID,
	int inInputQueueSize,
	bool inAutoTrigger,
	ftl::Optional<int> inAutoTriggerPeriod,
	fil::ZebraScanEnginesOperationModes::Type inOperationMode,
	fil::ZebraScanEnginesImageTypes::Type inImageType,
	fil::Image& outImage
)

Parameters

Name Type Range Default Description
Input will be modified ioState ZebraScanEngines_State& Object used to maintain state of the function.
Input value inDeviceID Optional<int> 1 - NIL Device identifying number
Input value inInputQueueSize int 1 - 200 4 Capacity of output frames queue
Input value inAutoTrigger bool True Enables or disables auto triggering
Input value inAutoTriggerPeriod Optional<int> 10 - NIL Period of automatic triggers (in ms)
Input value inOperationMode ZebraScanEnginesOperationModes::Type VideoMode Scanner operation mode (video/snapshot)
Input value inImageType ZebraScanEnginesImageTypes::Type BmpFile Image format for the snapshot mode
Output value outImage Image& Captured frame

Remarks

This filter is intended to cooperate with a scanner using its vendor SDK. To be able to connect to a scanner, it is required to install Zebra Scanner SDK software with Zebra CoreScanner Driver.

Zebra Scanner SDK can be downloaded from the following website: https://www.zebra.com/us/en/support-downloads/software/developer-tools/scanner-sdk-for-windows.html (registration may be required).

Add DLL path to system environment variable may be required.

Recommended Zebra Scanner SDK version for FabImage Studio usage is 3.06.0024.

Scanner identification

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

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

  • ID number - can be obtained from Scanner SDK Sample Application which is installed during the Zebra Scanner SDK installation. The ID is the number in the column "#" under "Connected Scanners".
Automatic trigger

inAutoTriggerPeriod field can be used to specify the period of the automatic trigger when inAutoTrigger is set to true. By default, when this field is set to Auto, the triggers are generated with a 1-second period. Be careful when choosing values for the period, as values that are too small can destabilize the device and not perform as expected.

Multithreaded environment

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

See Also