All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
Barcode Feature

Classes

struct  VuBarcodeConfig
 Configuration for creating a barcode observer. More...
 
struct  VuBarcodeObservationInstanceInfo
 Instance info for a barcode from its respective observation. More...
 
struct  VuBarcodeObservationInfo
 Info for a barcode from its respective observation. More...
 

Typedefs

typedef struct VuBarcodeTypeSet_ VuBarcodeTypeSet
 VuBarcodeType set.
 

Enumerations

enum  VuBarcodeCreationError : int32_t {
  VU_BARCODE_CREATION_ERROR_NONE = 0x0 ,
  VU_BARCODE_CREATION_ERROR_INTERNAL = 0x1 ,
  VU_BARCODE_CREATION_ERROR_OBSERVED_TYPES_EMPTY = 0x2
}
 Configuration error for barcode creation. More...
 
enum  VuBarcodeType : int32_t {
  VU_BARCODE_TYPE_UPCA = 0x1 ,
  VU_BARCODE_TYPE_UPCE = 0x2 ,
  VU_BARCODE_TYPE_EAN8 = 0x3 ,
  VU_BARCODE_TYPE_EAN13 = 0x4 ,
  VU_BARCODE_TYPE_CODE39 = 0x5 ,
  VU_BARCODE_TYPE_CODE93 = 0x6 ,
  VU_BARCODE_TYPE_CODE128 = 0x7 ,
  VU_BARCODE_TYPE_CODABAR = 0x8 ,
  VU_BARCODE_TYPE_ITF = 0x9 ,
  VU_BARCODE_TYPE_QRCODE = 0xA ,
  VU_BARCODE_TYPE_DATAMATRIX = 0xB ,
  VU_BARCODE_TYPE_AZTEC = 0xC ,
  VU_BARCODE_TYPE_PDF417 = 0xD ,
  VU_BARCODE_TYPE_MICROQRCODE = 0xE
}
 Type of barcode observed. More...
 
enum  VuBarcodeDetectionMode : int32_t {
  VU_BARCODE_DETECTION_MODE_SINGLE = 0x1 ,
  VU_BARCODE_DETECTION_MODE_MULTIPLE = 0x2
}
 Barcode detection mode. More...
 
enum  { VU_OBSERVER_BARCODE_TYPE = 0x10 }
 
enum  { VU_OBSERVATION_BARCODE_TYPE = 0x10 }
 

Functions

VuBarcodeConfig vuBarcodeConfigDefault ()
 Default barcode configuration.
 
VuResult vuEngineCreateBarcodeObserver (VuEngine *engine, VuObserver **observer, const VuBarcodeConfig *config, VuBarcodeCreationError *error)
 Create a barcode observer.
 
VuResult vuEngineGetBarcodeObservers (const VuEngine *engine, VuObserverList *observerList)
 Get all barcode observers.
 
VuResult vuBarcodeObserverGetObservedTypes (const VuObserver *observer, VuBarcodeTypeSet *types)
 Get the set of barcode types that will be observed by the observer.
 
VuResult vuBarcodeTypeSetCreate (VuBarcodeTypeSet **list)
 Create barcode type set.
 
VuResult vuBarcodeTypeSetGetSize (const VuBarcodeTypeSet *set, int32_t *setSize)
 Get number of elements in a barcode type set.
 
VuResult vuBarcodeTypeSetHasElement (const VuBarcodeTypeSet *set, VuBarcodeType type, VuBool *result)
 Return VU_TRUE if an element is found in a barcode type set.
 
VuResult vuBarcodeTypeSetAddElement (VuBarcodeTypeSet *set, VuBarcodeType type)
 Add an element to a barcode type set.
 
VuResult vuBarcodeTypeSetDestroy (VuBarcodeTypeSet *set)
 Destroy a barcode type set.
 
VuResult vuStateGetBarcodeObservations (const VuState *state, VuObservationList *observationList)
 Get all barcode observations.
 
VuResult vuBarcodeObservationGetInfo (const VuObservation *observation, VuBarcodeObservationInfo *info)
 Get the barcode info associated with a Barcode observation.
 
VuResult vuBarcodeObservationGetInstanceInfo (const VuObservation *observation, VuBarcodeObservationInstanceInfo *instanceInfo)
 Get the barcode instance info associated with a Barcode observation.
 

Detailed Description

An activated barcode observer will only output an observation when a barcode can be found in the camera image.

Note
Only one observed barcode is reported in a barcode observation for a given frame, even if multiple candidates can be seen by the camera in that frame. It is not guaranteed that the same barcode is reported for consecutive frames under these circumstances.
There may only be one barcode observer active at a time. Activating a barcode observer while another one is already active will fail.

Enumeration Type Documentation

◆ VuBarcodeCreationError

enum VuBarcodeCreationError : int32_t

Configuration error for barcode creation.

Enumerator
VU_BARCODE_CREATION_ERROR_NONE 

No error.

VU_BARCODE_CREATION_ERROR_INTERNAL 

An internal error occurred while creating the observer.

VU_BARCODE_CREATION_ERROR_OBSERVED_TYPES_EMPTY 

The set of barcode types to observe is empty.

◆ VuBarcodeType

enum VuBarcodeType : int32_t

Type of barcode observed.

Enumerator
VU_BARCODE_TYPE_UPCA 

1D barcode type, UPC-A

VU_BARCODE_TYPE_UPCE 

1D barcode type, UPC-E

VU_BARCODE_TYPE_EAN8 

1D barcode type, EAN-8

VU_BARCODE_TYPE_EAN13 

1D barcode type, EAN-13

VU_BARCODE_TYPE_CODE39 

1D barcode type, CODE 39

VU_BARCODE_TYPE_CODE93 

1D barcode type, CODE 93

VU_BARCODE_TYPE_CODE128 

1D barcode type, CODE 128

VU_BARCODE_TYPE_CODABAR 

1D barcode type, Codabar

VU_BARCODE_TYPE_ITF 

1D barcode type, ITF

VU_BARCODE_TYPE_QRCODE 

2D barcode type, QR Code

VU_BARCODE_TYPE_DATAMATRIX 

2D barcode type, Data Matrix

VU_BARCODE_TYPE_AZTEC 

2D barcode type, Aztec

VU_BARCODE_TYPE_PDF417 

2D barcode type, PDF417

VU_BARCODE_TYPE_MICROQRCODE 

2D barcode type, Micro QR Code

◆ VuBarcodeDetectionMode

enum VuBarcodeDetectionMode : int32_t

Barcode detection mode.

Enumerator
VU_BARCODE_DETECTION_MODE_SINGLE 

The observer detects only a single barcode at a time. This mode works best in scenarios where only one barcode is visible.

VU_BARCODE_DETECTION_MODE_MULTIPLE 

The observer detects multiple barcodes in parallel and produces a separate obseration for each barcode found in the frame.

◆ anonymous enum

anonymous enum
Enumerator
VU_OBSERVER_BARCODE_TYPE 

Type identifier for barcode observers.

◆ anonymous enum

anonymous enum
Enumerator
VU_OBSERVATION_BARCODE_TYPE 

Type identifier for barcode observations.

Function Documentation

◆ vuBarcodeConfigDefault()

VuBarcodeConfig vuBarcodeConfigDefault ( )

Default barcode configuration.

Note
Use this function to initialize the VuBarcodeConfig data structure with default values.

◆ vuEngineCreateBarcodeObserver()

VuResult vuEngineCreateBarcodeObserver ( VuEngine * engine,
VuObserver ** observer,
const VuBarcodeConfig * config,
VuBarcodeCreationError * error )

Create a barcode observer.

Note
Only one barcode observer can be active at a time.

◆ vuBarcodeTypeSetAddElement()

VuResult vuBarcodeTypeSetAddElement ( VuBarcodeTypeSet * set,
VuBarcodeType type )

Add an element to a barcode type set.

Nothing is done if the type is already in the set.