Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for Xamarin.Android and Data Capture SDK Documentation for Xamarin.iOS

Package ScanditBarcodeScanner.iOS

Classes

interface  Barcode
 
interface  BarcodePicker
 
interface  CancelDelegate
 
interface  IScanSession
 
interface  License
 
interface  Parser
 
interface  ParserField
 
interface  ParserResult
 
interface  ProcessFrameDelegate
 
interface  PropertyObserver
 
struct  Quadrilateral
 
interface  RecognizedText
 
interface  ScanCase
 
interface  ScanCaseDelegate
 
interface  ScanCaseSession
 
interface  ScanCaseSettings
 
interface  ScanDelegate
 
interface  ScanOverlay
 
interface  ScanSettings
 
interface  SymbologySettings
 
interface  TextRecognitionDelegate
 
interface  TextRecognitionSettings
 
interface  TrackedBarcode
 

Enumerations

enum  CameraFacingDirection { Back, Front }
 
enum  Orientation { Portrait, Landscape }
 
enum  WorkingRange { Standard, Long }
 
enum  Checksum {
  None, Mod10, Mod11, Mod47,
  Mod103, Mod1010, Mod1110, Mod43
}
 
enum  GuiStyle {
  Default, Laser, None, MatrixScan,
  LocationsOnly
}
 
enum  CameraSwitchVisibility { Never, OnTablet, Always }
 
enum  MatrixScanHighlightingState { Localized, Recognized, Rejected }
 
enum  Symbology {
  Unknown, EAN13, UPC12, UPCE,
  Code39, PDF417, Datamatrix, QR,
  ITF, Code128, Code93, MSIPlessey,
  GS1Databar, GS1DatabarExpanded, Codabar, EAN8,
  Aztec, TwoDigitAddOn, FiveDigitAddOn, Code11,
  MaxiCode, GS1DatabarLimited, Code25, MicroPDF417,
  RM4SCC, KIX, DotCode, MicroQr
}
 
enum  CompositeFlag {
  None, Unknown, Linked, Gs1TypeA,
  Gs1TypeB, Gs1TypeC
}
 
enum  RecognitionMode { Text, Code }
 
enum  BarcodePickerState { Active, Paused, Stopped }
 
enum  ParserDataFormat
 
enum  TorchMode
 
enum  ScanCaseState { Off, Standby, Active }
 
enum  ScanCaseStateChangeReason { Manual, Timeout, VolumeButton }
 

Class Documentation

struct ScanditBarcodeScanner::iOS::Quadrilateral

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

Enumeration of different camera orientations.

Since
2.1.7
Enumerator
Back 

Default camera orientation - facing away from user.

Front 

Facetime camera orientation - facing the user.

Enumeration of different device orientations.

Enumerator
Portrait 

Portrait orientation - short side facing down/up.

Landscape 

Landscape orientation - long side facing down/up.

Enumerates the possible working ranges for the barcode picker.

Since
4.1.0
Enumerator
Standard 

The camera tries to focus on barcodes which are close to the camera.

To scan far- away codes (30-40cm+), user must tap the screen. This is the default working range and works best for most use-cases. Only change the default value if you expect the users to often scan codes which are far away.

Long 

The camera tries to focus on barcodes which are far from the camera.

This will make it easier to scan codes that are far away but degrade performance for very close codes.

enum Checksum

Possible checksum algorithms.

Enumerator
None 

No optional checksum.

Mod10 

Modulo 10 checksum.

Mod11 

Modulo 11 checksum.

Mod47 

Modulo 47 checksum.

Mod103 

Modulo 103 checksum.

Mod1010 

Two modulo 10 checksums.

Mod1110 

A modulo 11 and a modulo 10 checksum.

Mod43 

Modulo 43 checksum.

enum GuiStyle

Enumeration of different GUI styles.

Since
4.8.0
Enumerator
Default 

A rectangular viewfinder with rounded corners is shown in the specified size.

Recognized codes are marked with four corners.

Laser 

A laser line is shown with the specified width while the height is not changeable.

This mode should generally not be used if the recognition is running on the whole screen as it indicates that the code should be placed at the location of the laser line.

None 

No UI is shown to indicate where the barcode should be placed.

Be aware that the Scandit logo continues to be displayed as showing it is part of the license agreement.

Barcode locations are not highlighted when using this UI style. Use LocationsOnly if you would like to see the barcode locations highlighted.

MatrixScan 

The matrix scan UI is shown.

In order to use this UI, it is required to set SBSScanSettings::matrixScanEnabled to YES.

Since
5.2.0
LocationsOnly 

Like None, but barcode locations are highlighted in the UI.

Since
5.3.0

Enumeration of different camera switch options.

Since
3.0.0
Enumerator
Never 

Never show it.

OnTablet 

Only show it on tablets.

Always 

Always show it.

Enumeration of different highlighting state of locations when using matrix scan.

Since
5.4.0
Enumerator
Localized 

State for tracked barcodes that have been localized, but not recognized yet.

Recognized 

State for tracked barcodes that have been recognized.

Rejected 

State for tracked barcodes that have been rejected with IScanSession.RejectTrackedCode.

enum Symbology

Enumerates the symbologies supported by Scandit Barcode Scanner.

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

Enumerator
Unknown 

Sentinel value to represent an unknown symbology.

EAN13 

EAN13 1D barcode symbology.

UPC12 

UPC12/UPCA 1D barcode symbology.

UPCE 

UPCE 1D barcode symbology.

Code39 

Code39 barcode symbology.

Only available in the Professional and Enterprise Packages.

PDF417 

PDF417 barcode symbology.

Only available in the Professional and Enterprise Packages.

Datamatrix 

Datamatrix 2D barcode symbology.

Only available in the Professional and Enterprise Packages.

QR 

QR Code 2D barcode symbology.

ITF 

Interleaved-Two-of-Five (ITF) 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

Code128 

Code 128 1D barcode symbology, including GS1-Code128.

Only available in the Professional and Enterprise Packages.

Code93 

Code 93 barcode symbology.

Only available in the Professional and Enterprise Packages.

MSIPlessey 

MSI Plessey 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

GS1Databar 

Databar 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

GS1DatabarExpanded 

Databar Expanded 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

Codabar 

Codabar 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

EAN8 

EAN8 1D barcode symbology.

Aztec 

Aztec 2D barcode symbology.

Only available in the Professional and Enterprise Packages.

TwoDigitAddOn 

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: EAN13, UPC12, UPCE, or EAN8 and the maximum number of codes per frame has to be set to at least 2.

Only available in the Professional and Enterprise Packages.

FiveDigitAddOn 

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: EAN13, UPC12, UPCE, or EAN8 and the maximum number of codes per frame has to be set to at least 2.

Only available in the Professional and Enterprise Packages.

Code11 

Code11 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

MaxiCode 

MaxiCode 2D barcode symbology.

Only available in the Professional and Enterprise Packages.

GS1DatabarLimited 

GS1 Databar Limited 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

Code25 

Code25 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

MicroPDF417 

MicroPDf417 2D barcode symbology.

RM4SCC 

Royal Mail 4 State Customer Code (RM4SCC)

Only available in Professional and Enterprise Packages

KIX 

Royal Dutch TPG Post KIX.

Only available in Professional and Enterprise Packages

DotCode 

DotCode 2d barcode symbology.

Only available in Professional and Enterprise Packages

MicroQr 

Micro QR 2d barcode symbology.

Only available in Professional and Enterprise Packages

Flags to hint that two codes form a composite code.

Enumerator
None 

Code is not part of a composite code.

Unknown 

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.

Linked 

Code is the linear component of a composite code.

This flag is can be set by GS1 DataBar or GS1-128 (Code 128).

Gs1TypeA 

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

Gs1TypeB 

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

Gs1TypeC 

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

Enumeration of supported recognition modes.

Enumerator
Text 

Text recognition is enabled.

Since
5.1
Code 

Barcode/2d code recognition is enabled.

Since
5.1

Enumerations of possible barcode picker states.

The barcode picker can be in one of three different states: active, paused, or stopped. When the picker is active, the camera preview is running and recognition is running. In paused state, the camera preview is running, but not recognition takes place. In stopped state, neither the preview nor recognition are running.

Since
5.1
Enumerator
Active 

Camera preview is on, recognition is running.

Since
5.1
Paused 

Camera preview is on, recognition is not running.

Since
5.1
Stopped 

Camera is not running, recognition is not running.

Since
5.1

The parser type.

Since
5.5
enum TorchMode

The torch mode.

Since
5.6

Enumerates the possible state for the scan case.

Since
4.16.0
Enumerator
Off 

Camera is off, torch is off.

Standby 

Camera is on but with throttled frame-rate, scanner is off, torch is off.

Active 

Camera is on, scanner is on, torch is on.

Enumerates the possible reasons for which the scan case state has changed.

Since
4.16.0
Enumerator
Manual 

The state was changed directly.

Timeout 

The change of state was driven by a timeout.

VolumeButton 

The change of state was driven by the volume button.