SBSCommon.h File Reference

Go to the source code of this file.

Macros
#define	SBS_DEPRECATED   __attribute__((deprecated))
#define	SBS_ENUM_BEGIN(name)   typedef enum
#define	SBS_ENUM_END(name)   name
#define	SBS_DESIGNATED_INITIALIZER
#define	SBS_NOT_AVAILABLE_IN_SWIFT
#define	SBS_SWIFT_NAME(method)
#define	SBS_DEPRECATED_MSG_ATTRIBUTE(message)

Typedefs
typedef SBSCameraFacingDirection	CameraFacingDirection
typedef SBSOrientation	Orientation
typedef SBSWorkingRange	WorkingRange
typedef SBSMsiPlesseyChecksumType	MsiPlesseyChecksumType

Enumerations
enum	SBSCameraFacingDirection { SBSCameraFacingDirectionBack, SBSCameraFacingDirectionFront, CAMERA_FACING_BACK = SBSCameraFacingDirectionBack, CAMERA_FACING_FRONT = SBSCameraFacingDirectionFront }
enum	SBSOrientation { SBSOrientationPortrait, SBSOrientationLandscape, ORIENTATION_PORTRAIT = SBSOrientationPortrait, ORIENTATION_LANDSCAPE = SBSOrientationLandscape }
enum	SBSWorkingRange {   SBSWorkingRangeStandard, SBSWorkingRangeLong, STANDARD_RANGE = SBSWorkingRangeStandard, LONG_RANGE = SBSWorkingRangeLong,   HIGH_DENSITY }
enum	SBSMsiPlesseyChecksumType {   SBSMsiPlesseyChecksumTypeNone, SBSMsiPlesseyChecksumTypeMod10, SBSMsiPlesseyChecksumTypeMod1010, SBSMsiPlesseyChecksumTypeMod11,   SBSMsiPlesseyChecksumTypeMod1110, NONE = SBSMsiPlesseyChecksumTypeNone, CHECKSUM_MOD_10 = SBSMsiPlesseyChecksumTypeMod10, CHECKSUM_MOD_1010 = SBSMsiPlesseyChecksumTypeMod1010,   CHECKSUM_MOD_11 = SBSMsiPlesseyChecksumTypeMod11, CHECKSUM_MOD_1110 = SBSMsiPlesseyChecksumTypeMod1110 }
enum	SBSGuiStyle {   SBSGuiStyleDefault, SBSGuiStyleLaser, SBSGuiStyleNone, SBSGuiStyleMatrixScan,   SBSGuiStyleLocationsOnly }
enum	SBSError { SBSErrorInvalidArgument = 1 }

Variables
FOUNDATION_EXPORT NSString *const	SBSErrorDomain

Macro Definition Documentation

#define SBS_DEPRECATED   __attribute__((deprecated))

#define SBS_ENUM_BEGIN

(

name

)

typedef enum

#define SBS_ENUM_END

(

name

)

name

#define SBS_DESIGNATED_INITIALIZER

#define SBS_NOT_AVAILABLE_IN_SWIFT

#define SBS_SWIFT_NAME

(

method

)

#define SBS_DEPRECATED_MSG_ATTRIBUTE

(

message

)

Typedef Documentation

typedef SBSCameraFacingDirection CameraFacingDirection

typedef SBSOrientation Orientation

typedef SBSWorkingRange WorkingRange

typedef SBSMsiPlesseyChecksumType MsiPlesseyChecksumType

Enumeration Type Documentation

enum SBSCameraFacingDirection

Enumeration of different camera orientations.

Since

2.1.7

Enumerator
SBSCameraFacingDirectionBack	Default camera orientation - facing away from user
SBSCameraFacingDirectionFront	Facetime camera orientation - facing the user
CAMERA_FACING_BACK
CAMERA_FACING_FRONT

enum SBSOrientation

Enumerator
SBSOrientationPortrait
SBSOrientationLandscape
ORIENTATION_PORTRAIT
ORIENTATION_LANDSCAPE

enum SBSWorkingRange

Enumerates the possible working ranges for the barcode picker

Since

4.1.0

Enumerator
SBSWorkingRangeStandard	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.
SBSWorkingRangeLong	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.
STANDARD_RANGE
LONG_RANGE
HIGH_DENSITY

enum SBSMsiPlesseyChecksumType

Enumeration of different MSI Checksums.

Since

3.0.0

Enumerator
SBSMsiPlesseyChecksumTypeNone
SBSMsiPlesseyChecksumTypeMod10	Default MSI Plessey Checksum
SBSMsiPlesseyChecksumTypeMod1010
SBSMsiPlesseyChecksumTypeMod11
SBSMsiPlesseyChecksumTypeMod1110
NONE
CHECKSUM_MOD_10
CHECKSUM_MOD_1010
CHECKSUM_MOD_11
CHECKSUM_MOD_1110

enum SBSGuiStyle

Enumeration of different GUI styles.

Since

4.8.0

Enumerator
SBSGuiStyleDefault	A rectangular viewfinder with rounded corners is shown in the specified size. Recognized codes are marked with four corners.
SBSGuiStyleLaser	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.
SBSGuiStyleNone	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 SBSGuiStyleLocationsOnly if you would like to see the barcode locations highlighted.
SBSGuiStyleMatrixScan	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
SBSGuiStyleLocationsOnly	Like SBSGuiStyleNone, but barcode locations are highlighted in the UI. Since 5.3.0

enum SBSError

enumeration of various error codes

Enumerator
SBSErrorInvalidArgument	An invalid argument has been passed to a method/function.

Variable Documentation

FOUNDATION_EXPORT NSString* const SBSErrorDomain

Error domain for the ScanditBarcodeScanner framework.

Since

4.11.0