Classes | Enumerations | Functions
SBSCode.h File Reference

Go to the source code of this file.

Classes

struct  SBSQuadrilateral
 
class  SBSCode
 

Enumerations

enum  SBSSymbology {
  SBSSymbologyUnknown = 0x0000000, SBSSymbologyEAN13 = 0x0000001, SBSSymbologyUPC12 = 0x0000004, SBSSymbologyUPCE = 0x0000008,
  SBSSymbologyCode39 = 0x0000020, SBSSymbologyPDF417 = 0x0000400, SBSSymbologyDatamatrix = 0x0000200, SBSSymbologyQR = 0x0000100,
  SBSSymbologyITF = 0x0000080, SBSSymbologyCode128 = 0x0000010, SBSSymbologyCode93 = 0x0000040, SBSSymbologyMSIPlessey = 0x0000800,
  SBSSymbologyGS1Databar = 0x0001000, SBSSymbologyGS1DatabarExpanded = 0x0002000, SBSSymbologyCodabar = 0x0004000, SBSSymbologyEAN8 = 0x0000002,
  SBSSymbologyAztec = 0x0008000, SBSSymbologyTwoDigitAddOn = 0x0010000, SBSSymbologyFiveDigitAddOn = 0x0020000, SBSSymbologyCode11 = 0x0080000,
  SBSSymbologyMaxiCode = 0x0040000, SBSSymbologyGS1DatabarLimited = 0x0100000, SBSSymbologyCode25 = 0x0200000, SBSSymbologyMicroPDF417 = 0x0400000,
  SBSSymbologyRM4SCC = 0x0800000, SBSSymbologyKIX = 0x1000000, SBSSymbologyDotCode = 0x2000000, SBSSymbologyMicroQR = 0x4000000,
  SBSSymbologyCode32 = 0x8000000, SBSSymbologyLAPA4SC = 0x10000000
}
 
enum  SBSCompositeFlag {
  SBSCompositeFlagNone = 0x0000000, SBSCompositeFlagUnknown = 0x0000001, SBSCompositeFlagLinked = 0x0000002, SBSCompositeFlagGs1TypeA = 0x0000004,
  SBSCompositeFlagGs1TypeB = 0x0000008, SBSCompositeFlagGs1TypeC = 0x0000010
}
 

Functions

SBSSymbology SBSSymbologyFromString (NSString *_Nullable symbologyString)
 

Class Documentation

struct SBSQuadrilateral

Quadrilateral represented by 4 corners.

Class Members
CGPoint topLeft The top-left corner.
CGPoint topRight The top-right corner.
CGPoint bottomRight The bottom-right corner.
CGPoint bottomLeft The bottom-left corner.

Enumeration Type Documentation

enum SBSSymbology

Enumerates the symbologies supported by Scandit Barcode Scanner.

Some of these symbologies are only available in the Professional and Enterprise Packages.

Enumerator
SBSSymbologyUnknown 

Sentinel value to represent an unknown symbology.

SBSSymbologyEAN13 

EAN-13 1D barcode symbology.

SBSSymbologyUPC12 

UPC-12/UPC-A 1D barcode symbology.

SBSSymbologyUPCE 

UPC-E 1D barcode symbology.

SBSSymbologyCode39 

Code 39 barcode symbology. Only available in the Professional and Enterprise Packages.

SBSSymbologyPDF417 

PDF417 barcode symbology. Only available in the Professional and Enterprise Packages.

SBSSymbologyDatamatrix 

Data Matrix 2D barcode symbology. Only available in the Professional and Enterprise Packages.

SBSSymbologyQR 

QR Code 2D barcode symbology.

SBSSymbologyITF 

Interleaved-Two-of-Five (ITF) 1D barcode symbology. Only available in the Professional and Enterprise Packages.

SBSSymbologyCode128 

Code 128 1D barcode symbology, including GS1-Code128. Only available in the Professional and Enterprise Packages.

SBSSymbologyCode93 

Code 93 barcode symbology. Only available in the Professional and Enterprise Packages.

SBSSymbologyMSIPlessey 

MSI Plessey 1D barcode symbology. Only available in the Professional and Enterprise Packages.

SBSSymbologyGS1Databar 

GS1 DataBar 14 1D barcode symbology. Only available in the Professional and Enterprise Packages.

SBSSymbologyGS1DatabarExpanded 

GS1 DataBar Expanded 1D barcode symbology. Only available in the Professional and Enterprise Packages.

SBSSymbologyCodabar 

Codabar 1D barcode symbology. Only available in the Professional and Enterprise Packages.

SBSSymbologyEAN8 

EAN-8 1D barcode symbology.

SBSSymbologyAztec 

Aztec Code 2D barcode symbology. Only available in the Professional and Enterprise Packages.

SBSSymbologyTwoDigitAddOn 

Two-digit add-on for UPC and EAN codes.

In order to scan two-digit add-on codes, at least one of these symbologies must be activated as well: SBSSymbologyEAN13, SBSSymbologyUPC12, SBSSymbologyUPCE, or SBSSymbologyEAN8 and the maximum number of codes per frame has to be set to at least 2.

Only available in the Professional and Enterprise Packages.

SBSSymbologyFiveDigitAddOn 

Five-digit add-on for UPC and EAN codes.

In order to scan five-digit add-on codes, at least one of these symbologies must be activated as well: SBSSymbologyEAN13, SBSSymbologyUPC12, SBSSymbologyUPCE, or SBSSymbologyEAN8 and the maximum number of codes per frame has to be set to at least 2.

Only available in the Professional and Enterprise Packages.

SBSSymbologyCode11 

Code 11 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

SBSSymbologyMaxiCode 

MaxiCode 2D barcode symbology.

Only available in the Professional and Enterprise Packages.

SBSSymbologyGS1DatabarLimited 

GS1 DataBar Limited 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

SBSSymbologyCode25 

Code25 1D barcode symbology.

Also known as 'Industrial 2 of 5', 'Standard 2 of 5' or 'Discrete 2 of 5'.

Only available in Professional and Enterprise Packages.

SBSSymbologyMicroPDF417 

Micro PDF417 2D barcode symbology.

Only available in Professional and Enterprise Packages.

SBSSymbologyRM4SCC 

Royal Mail 4 State Customer Code (RM4SCC).

Only available in Professional and Enterprise Packages.

SBSSymbologyKIX 

Royal Dutch TPG Post KIX.

Only available in Professional and Enterprise Packages.

SBSSymbologyDotCode 

DotCode 2d barcode symbology.

Only available in Professional and Enterprise Packages.

SBSSymbologyMicroQR 

Micro QR 2d barcode symbology.

SBSSymbologyCode32 

Italian Pharma Code (Code32) barcode symbology.

Only available in Professional and Enterprise Packages.

SBSSymbologyLAPA4SC 

Posti LAPA (Lajittelupalvelu) 4 State Code.

enum SBSCompositeFlag

Flags to hint that two codes form a composite code.

Since
4.14.0
Enumerator
SBSCompositeFlagNone 

Code is not part of a composite code.

SBSCompositeFlagUnknown 

Code could be part of a composite code. This flag is set by linear (1d) symbologies that have no composite flag support but can be part of a composite code like the EAN/UPC symbology family.

SBSCompositeFlagLinked 

Code is the linear component of a composite code. This flag can be set by GS1 DataBar or GS1-128 (Code 128).

SBSCompositeFlagGs1TypeA 

Code is a GS1 Composite Code Type A (CC-A). This flag can be set by MicroPDF417 codes.

SBSCompositeFlagGs1TypeB 

Code is a GS1 Composite Code Type B (CC-B). This flag can be set by MicroPDF417 codes.

SBSCompositeFlagGs1TypeC 

Code is a GS1 Composite Code Type C (CC-C). This flag can be set by PDF417 codes.

Function Documentation

SBSSymbology SBSSymbologyFromString ( NSString *_Nullable  symbologyString)

Helper function to convert a symbology string to its corresponding symbology enum.

Parameters
symbologyStringNSString with symbology name
Returns
the enum value for the given symbology string
Since
5.7.0
Copyright (C) 2021 Scandit AG