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

ZebraScanEngines_StartAcquisition

Header:	ThirdPartySdk.h
Namespace:	avl
Module:	ThirdParty

Initializes and starts image acquisition in a scanner.

Syntax

void avl::ZebraScanEngines_StartAcquisition
(
	ZebraScanEngines_State& ioState,
	atl::Optional<int> inDeviceID,
	int inInputQueueSize,
	bool inAutoTrigger,
	atl::Optional<int> inAutoTriggerPeriod,
	avl::ZebraScanEnginesOperationModes::Type inOperationMode,
	avl::ZebraScanEnginesImageTypes::Type inImageType
)

Parameters

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

Remarks

This filter is intended for establishing connection with a Zebra scanner device using Zebra Scanner SDK interface, to initialize image streaming. It is only needed when explicit image acquisition start is required in the initial phase of a program.

The use of this filter is not obligatory. ZebraScanEngines_GrabImage or ZebraScanEngines_GrabImage_WithTimeout] filters will initialize and start image acquisition upon their first invoke.

This filter has no effect when invoked for the second time and when invoked after image grabbing filters.

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 Aurora Vision 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".

Multithreaded environment