Back to Aurora Vision Library website

You are here: Start » Function Reference » Computer Vision » Datacodes » ReadSingleCode_Z

ReadSingleCode_Z


Header: AVL.h
Namespace: avl
Module: Datacodes

Reads a single 1D barcode or a PDF417 code.

Applications: High-speed barcode reading with simple configuration.

Syntax

C++
C#
 
void avl::ReadSingleCode_Z
(
	ZCode_State& ioState,
	const avl::Image& inImage,
	const atl::Optional<atl::File>& inLoadConfigFile,
	const atl::Optional<atl::File>& inSaveConfigFile,
	atl::Optional<int> inTimeout,
	atl::Optional<int> inThreadCount,
	const avl::Code1DSettings& inCode1DSettings,
	bool inEnablePDF417,
	bool inEnableCode128,
	atl::Conditional<avl::ZResult>& outResult
)

Parameters

Name Type Range Default Description
Input will be modified ioState ZCode_State& Object used to maintain state of the function.
Input value inImage const Image& Input image
Input value inLoadConfigFile const Optional<File>& NIL Configuration file to be loaded in .bin format. Used to restore previously saved settings - can overwrite other parameters.
Input value inSaveConfigFile const Optional<File>& NIL Path to save configuration file in .bin format. Used to save current settings for future use.
Input value inTimeout Optional<int> 1 - NIL Processing timeout in ms
Input value inThreadCount Optional<int> 1 - 31 NIL Number of processing threads
Input value inCode1DSettings const Code1DSettings& Code1D settings
Input value inEnablePDF417 bool True
Input value inEnableCode128 bool True
Output value outResult Conditional<ZResult>& Decode results

Requirements

For input inImage only pixel formats are supported: uint8.

Read more about pixel formats in Image documentation.

Errors

List of possible exceptions:

Error type Description
DomainError ReadSingleCode_Z is not supported on this platform.
DomainError Not supported inImage pixel format in ReadSingleCode_Z. Supported formats: UInt8.