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 Scandit.BarcodePicker.Unified

Namespaces

package  Abstractions
 

Classes

class  Barcode
 
struct  Point
 
class  Quad
 
struct  Rect
 
class  ScanditService
 
class  ScanOverlay
 
class  ScanSession
 
class  ScanSettings
 
struct  Size
 
class  SymbologySettings
 

Enumerations

enum  CameraSwitchVisibility { Never, OnTablets, Always }
 
enum  Checksum {
  None, Mod10, Mod11, Mod47,
  Mod103, Mod1010, Mod1110, Mod43
}
 
enum  CompositeFlag {
  None, Unknown, Linked, Gs1TypeA,
  Gs1TypeB
}
 
enum  DidStopReason { CancelledInUserInterface, Programmatic }
 
enum  GuiStyle { Rectangle, Default, Laser, None }
 
enum  Symbology : uint {
  Unknown, Ean13, Ean8, Upca,
  Upce, Code128, Code39, Code93,
  Interleaved2Of5, Qr, DataMatrix, Pdf417,
  MsiPlessey, Gs1Databar, Gs1DatabarExpanded, Gs1DatabarLimited,
  Codabar, Aztec, TwoDigitAddOn, FiveDigitAddOn,
  Code11, MaxiCode, Code25, MicroPdf417,
  Rm4scc, Kix
}
 
enum  VideoResolution { Medium, High }
 

Enumeration Type Documentation

Controls the visibility of the camera switch button

Enumerator
Never 

Never show the camera switch button

OnTablets 

Only show the camera switch button on tablets.

The camera switch button will only be shown on devices with front and back camera that are not phones.

Always 

Show the camera switch button for all devices that have a front and back camera.

enum Checksum

A list of possible checksum algorithms.

Enumerator
None 

No checksum algorithm

Mod10 

Checksum is calculated using modulo of 10

Mod11 

Checksum is calculated using modulo of 11

Mod47 

Checksum is calculated using modulo of 47

Mod103 

Checksum is calculated using modulo of 103

Mod1010 

Checksum is calculated as two modulo 10 checksums

Mod1110 

Checksum is calculated as a Modulo 11 and a modulo 10 checksum

Mod43 

Checksum calculated as module 43

Flags to hint that two codes form a composite code.

Enumerator
None 

summary>Code is not part of a composite code.

summary>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.

Unknown 

summary> Code is the linear component of a composite code.

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

Linked 

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

Gs1TypeA 

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

Gs1TypeB 

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

Lists possible reasons for how the barcode scanning was stopped.

Enumerator
CancelledInUserInterface 

The user has cancelled the scanning process through the user interace.

Programmatic 

Stop has been called programmatically from the application, e.g.

by calling IBarcodePicker.StopScanningAsync etc.

enum GuiStyle

Defines the UI style to be used for the scan overlay

Enumerator
Rectangle 

The view finder is shown as a rectangle

Default 

The default view finder style, identical to rectangle

Laser 

Shows a laser line

None 

Only the scandit logo is shown

enum Symbology : uint

Enumeration of all supported 1d and 2d barcode symbologies

Enumerator
Unknown 

the symbology is unknown/undefined

Ean13 

EAN13

Ean8 

EAN8

Upca 

UPCA

Upce 

UPCE

Code128 

Code128

Code39 

Code39

Code93 

Code93

Interleaved2Of5 

Interleaved 2 of 5 (ITF)

Qr 

QR Code

DataMatrix 

Data Matrix

Pdf417 

PDF417

MsiPlessey 

MSI Plessey

Gs1Databar 

GS1 DataBar

Gs1DatabarExpanded 

GS1 DataBar Expanded

Gs1DatabarLimited 

GS1 DataBar Limited 1d barcode symbology

Codabar 

Codabar

Aztec 

Aztec code

TwoDigitAddOn 

EAN/UPC two-digit add-on, also known as EAN/UPC extension or supplemental code.

FiveDigitAddOn 

EAN/UPC five-digit add-on, also known as EAN/UPC extension or supplemental code.

Code11 

Code11 1d barcode symbology.

MaxiCode 

MaxiCode 2d symbology.

Code25 

Code 25 1d barcode symbology.

MicroPdf417 

MicroPDf417 2d barcode symbology

Rm4scc 

RM4SCC (Royal Mail 4 State Customer Code) postal code symbology

Kix 

KIX postal code symbology

An enum defining video resolutions

Enumerator
Medium 

Medium resolution.

This will select 1280x720 on most devices.

High 

High resolution.

This will select 1920x1080 on most devices.