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 iOS

SBSCode.h
Go to the documentation of this file.
1 //
2 // SBSCode.h
3 // BarcodeScanner
4 //
5 // Created by Marco Biasini on 20/05/15.
6 // Copyright (c) 2015 Scandit AG. All rights reserved.
7 //
8 
9 #import <Foundation/Foundation.h>
10 #import <CoreGraphics/CoreGraphics.h>
11 #import <UIKit/UIKit.h>
12 
13 #import "SBSCommon.h"
14 
20 typedef struct {
24  CGPoint topLeft;
28  CGPoint topRight;
32  CGPoint bottomRight;
36  CGPoint bottomLeft;
38 
48  SBSSymbologyUnknown = 0x0000000,
52  SBSSymbologyEAN13 SBS_SWIFT_NAME(ean13) = 0x0000001,
56  SBSSymbologyUPC12 SBS_SWIFT_NAME(upc12) = 0x0000004,
60  SBSSymbologyUPCE SBS_SWIFT_NAME(upce) = 0x0000008,
64  SBSSymbologyCode39 = 0x0000020,
68  SBSSymbologyPDF417 SBS_SWIFT_NAME(pdf417) = 0x0000400,
76  SBSSymbologyQR SBS_SWIFT_NAME(qr) = 0x0000100,
81  SBSSymbologyITF SBS_SWIFT_NAME(itf) = 0x0000080,
86  SBSSymbologyCode128 = 0x0000010,
90  SBSSymbologyCode93 = 0x0000040,
94  SBSSymbologyMSIPlessey SBS_SWIFT_NAME(msiPlessey) = 0x0000800,
98  SBSSymbologyGS1Databar SBS_SWIFT_NAME(gs1Databar) = 0x0001000,
102  SBSSymbologyGS1DatabarExpanded SBS_SWIFT_NAME(gs1DatabarExpanded) = 0x0002000,
106  SBSSymbologyCodabar = 0x0004000,
110  SBSSymbologyEAN8 SBS_SWIFT_NAME(ean8) = 0x0000002,
114  SBSSymbologyAztec = 0x0008000,
140  SBSSymbologyCode11 = 0x0080000,
146  SBSSymbologyMaxiCode = 0x0040000,
152  SBSSymbologyGS1DatabarLimited SBS_SWIFT_NAME(gs1DatabarLimited) = 0x0100000,
160  SBSSymbologyCode25 = 0x0200000,
172  SBSSymbologyRM4SCC SBS_SWIFT_NAME(rm4scc) = 0x0800000,
178  SBSSymbologyKIX SBS_SWIFT_NAME(kix) = 0x1000000,
184  SBSSymbologyDotCode = 0x2000000,
188  SBSSymbologyMicroQR = 0x4000000,
194  SBSSymbologyCode32 = 0x8000000,
195 
199  SBSSymbologyLAPA4SC SBS_SWIFT_NAME(lapa4sc) = 0x10000000,
201 
211  SBSCompositeFlagNone = 0x0000000,
234  SBSCompositeFlagGs1TypeC = 0x0000010
236 
245 #ifdef __cplusplus
246 extern "C" {
247 #endif
248 SBSSymbology SBSSymbologyFromString(NSString * _Nullable symbologyString);
249 #ifdef __cplusplus
250 }
251 #endif
252 
259 @interface SBSCode : NSObject
260 
268 @property (nonnull, nonatomic, readonly) NSString *symbologyString SBS_DEPRECATED_MSG_ATTRIBUTE("Use symbologyName instead.");
269 
280 @property (nonnull, nonatomic, readonly) NSString *symbologyName;
281 
287 @property (nonatomic, readonly) SBSSymbology symbology;
288 
299 @property (nullable, nonatomic, readonly) NSString *data;
300 
308 @property (nullable, nonatomic, readonly) NSData *rawData;
309 
320 @property (nonatomic, readonly) BOOL isRecognized;
321 
333 @property (nonatomic, readonly) SBSQuadrilateral location;
334 
343 @property (nonatomic, readonly) BOOL isGs1DataCarrier;
344 
352 @property (nonatomic, readonly) int symbolCount;
353 
360 @property (nonatomic, readonly) SBSCompositeFlag compositeFlag;
361 
369 @property (nonatomic, readonly) BOOL isColorInverted;
370 
371 @end
@ SBSSymbologyQR
Definition: SBSCode.h:76
@ SBSSymbologyMSIPlessey
Definition: SBSCode.h:94
@ SBSSymbologyRM4SCC
Definition: SBSCode.h:172
BOOL isColorInverted
Whether the scanned code is color inverted.
Definition: SBSCode.h:369
SBSQuadrilateral location
The location of the code in the image.
Definition: SBSCode.h:333
#define SBS_ENUM_BEGIN(name)
Definition: SBSCommon.h:16
BOOL isRecognized
Whether the code was completely recognized.
Definition: SBSCode.h:320
@ SBSSymbologyUPC12
Definition: SBSCode.h:56
NSString * symbologyName
The symbology name of the barcode as a string.
Definition: SBSCode.h:280
CGPoint topRight
The top-right corner.
Definition: SBSCode.h:28
@ SBSSymbologyPDF417
Definition: SBSCode.h:68
CGPoint topLeft
The top-left corner.
Definition: SBSCode.h:24
@ SBSSymbologyCode39
Definition: SBSCode.h:64
@ SBSSymbologyTwoDigitAddOn
Definition: SBSCode.h:124
Represents a recognized/localized barcode/2D code.
Definition: SBSCode.h:260
@ SBSSymbologyCodabar
Definition: SBSCode.h:106
@ SBSSymbologyCode25
Definition: SBSCode.h:160
#define SBS_ENUM_END(name)
Definition: SBSCommon.h:17
SBSCompositeFlag
Flags to hint that two codes form a composite code.
Definition: SBSCode.h:207
@ SBSCompositeFlagGs1TypeC
Definition: SBSCode.h:234
@ SBSSymbologyUPCE
Definition: SBSCode.h:60
@ SBSSymbologyMicroPDF417
Definition: SBSCode.h:166
@ SBSSymbologyMicroQR
Definition: SBSCode.h:188
SBSSymbology
Enumerates the symbologies supported by Scandit Barcode Scanner.
Definition: SBSCode.h:44
#define SBS_DEPRECATED_MSG_ATTRIBUTE(message)
Definition: SBSCommon.h:21
@ SBSCompositeFlagLinked
Definition: SBSCode.h:222
@ SBSSymbologyEAN8
Definition: SBSCode.h:110
@ SBSCompositeFlagGs1TypeB
Definition: SBSCode.h:230
@ SBSSymbologyGS1DatabarLimited
Definition: SBSCode.h:152
@ SBSSymbologyLAPA4SC
Definition: SBSCode.h:199
@ SBSSymbologyDotCode
Definition: SBSCode.h:184
SBSCompositeFlag compositeFlag
Flag to hint whether the barcode is part of a composite code.
Definition: SBSCode.h:360
@ SBSSymbologyCode93
Definition: SBSCode.h:90
@ SBSSymbologyAztec
Definition: SBSCode.h:114
@ SBSSymbologyMaxiCode
Definition: SBSCode.h:146
@ SBSSymbologyUnknown
Sentinel value to represent an unknown symbology.
Definition: SBSCode.h:48
NSString * symbologyString
The symbology of the barcode as a string, including GS1 data carrier states.
Definition: SBSCode.h:268
@ SBSCompositeFlagNone
Definition: SBSCode.h:211
@ SBSSymbologyCode128
Definition: SBSCode.h:86
@ SBSCompositeFlagUnknown
Definition: SBSCode.h:217
@ SBSSymbologyCode32
Definition: SBSCode.h:194
SBSSymbology SBSSymbologyFromString(NSString *_Nullable symbologyString)
Helper function to convert a symbology string to its corresponding symbology enum.
CGPoint bottomLeft
The bottom-left corner.
Definition: SBSCode.h:36
@ SBSSymbologyCode11
Definition: SBSCode.h:140
@ SBSSymbologyGS1DatabarExpanded
Definition: SBSCode.h:102
CGPoint bottomRight
The bottom-right corner.
Definition: SBSCode.h:32
@ SBSSymbologyDatamatrix
Definition: SBSCode.h:72
@ SBSSymbologyKIX
Definition: SBSCode.h:178
@ SBSSymbologyGS1Databar
Definition: SBSCode.h:98
NSString * data
The data contained in the barcode/2D code, e.g. the 13 digit number of a EAN-13 code.
Definition: SBSCode.h:299
@ SBSSymbologyEAN13
Definition: SBSCode.h:52
@ SBSSymbologyITF
Definition: SBSCode.h:81
int symbolCount
The symbol count of this barcode.
Definition: SBSCode.h:352
Quadrilateral represented by 4 corners.
Definition: SBSCode.h:20
NSData * rawData
The raw byte data contained in the barcode.
Definition: SBSCode.h:308
@ SBSCompositeFlagGs1TypeA
Definition: SBSCode.h:226
SBSSymbology symbology
Returns the symbology of a recognized barcode.
Definition: SBSCode.h:287
@ SBSSymbologyFiveDigitAddOn
Definition: SBSCode.h:134
#define SBS_SWIFT_NAME(method)
Definition: SBSCommon.h:20
BOOL isGs1DataCarrier
Whether the code is a GS1 data carrier.
Definition: SBSCode.h:343