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,
147 
153  SBSSymbologyGS1DatabarLimited SBS_SWIFT_NAME(gs1DatabarLimited) = 0x0100000,
161  SBSSymbologyCode25 = 0x0200000,
162 
169 
175  SBSSymbologyRM4SCC SBS_SWIFT_NAME(rm4scc) = 0x0800000,
181  SBSSymbologyKIX SBS_SWIFT_NAME(kix) = 0x1000000,
183 
184 
195  SBSCompositeFlagNone = 0x0000000,
220 
221 
228 @interface SBSCode : NSObject
229 
243 @property (nonnull, nonatomic, readonly) NSString *symbologyString;
244 
255 @property (nonnull, nonatomic, readonly) NSString *symbologyName;
256 
262 @property (nonatomic, readonly) SBSSymbology symbology;
263 
264 
275 @property (nullable, nonatomic, readonly) NSString *data;
276 
284 @property (nullable, nonatomic, readonly) NSData *rawData;
285 
296 @property (nonatomic, readonly) BOOL isRecognized;
297 
309 @property (nonatomic, readonly) SBSQuadrilateral location;
310 
319 @property (nonatomic, readonly) BOOL isGs1DataCarrier;
320 
328 @property (nonatomic, readonly) int symbolCount;
329 
336 @property (nonatomic, readonly) SBSCompositeFlag compositeFlag;
337 
338 
339 @end
Definition: SBSCode.h:102
BOOL isRecognized
Whether the code was completely recognized.
Definition: SBSCode.h:296
NSString * symbologyName
The symbology name of the barcode as a string.
Definition: SBSCode.h:255
NSData * rawData
The raw byte data contained in the barcode.
Definition: SBSCode.h:284
SBSSymbology symbology
Returns the symbology of a recognized barcode.
Definition: SBSCode.h:262
Definition: SBSCode.h:195
Definition: SBSCode.h:52
BOOL isGs1DataCarrier
Whether the code is a GS1 data carrier.
Definition: SBSCode.h:319
Represents a recognized/localized barcode/2D code.
Definition: SBSCode.h:228
Definition: SBSCode.h:86
int symbolCount
The symbol count of this barcode.
Definition: SBSCode.h:328
NSString * symbologyString
The symbology of the barcode as a string, including GS1 data carrier states.
Definition: SBSCode.h:243
SBSQuadrilateral location
The location of the code in the image.
Definition: SBSCode.h:309
Definition: SBSCode.h:206
Definition: SBSCode.h:64
Definition: SBSCode.h:68
#define SBS_ENUM_END(name)
Definition: SBSCommon.h:17
Definition: SBSCode.h:153
Definition: SBSCode.h:72
Definition: SBSCode.h:114
Sentinel value to represent an unknown symbology.
Definition: SBSCode.h:48
Definition: SBSCode.h:210
SBSSymbology
Enumerates the symbologies supported by Scandit Barcode Scanner.
Definition: SBSCode.h:44
CGPoint topRight
The top-right corner.
Definition: SBSCode.h:28
Definition: SBSCode.h:161
Definition: SBSCode.h:201
Definition: SBSCode.h:106
Definition: SBSCode.h:175
Definition: SBSCode.h:168
Definition: SBSCode.h:76
SBSCompositeFlag
Flags to hint that two codes form a composite code.
Definition: SBSCode.h:191
Definition: SBSCode.h:124
Definition: SBSCode.h:181
Definition: SBSCode.h:134
Definition: SBSCode.h:110
NSString * data
The data contained in the barcode/2D code, e.g. the 13 digit number of a EAN-13 code.
Definition: SBSCode.h:275
CGPoint bottomLeft
The bottom-left corner.
Definition: SBSCode.h:36
Definition: SBSCode.h:56
Definition: SBSCode.h:146
Definition: SBSCode.h:218
CGPoint topLeft
The top-left corner.
Definition: SBSCode.h:24
SBSCompositeFlag compositeFlag
Flag to hint whether the barcode is part of a composite code.
Definition: SBSCode.h:336
Definition: SBSCode.h:98
Definition: SBSCode.h:81
Definition: SBSCode.h:214
CGPoint bottomRight
The bottom-right corner.
Definition: SBSCode.h:32
Definition: SBSCode.h:140
Definition: SBSCode.h:90
#define SBS_SWIFT_NAME(method)
Definition: SBSCommon.h:20
Definition: SBSCode.h:94
Definition: SBSCode.h:60
Quadrilateral represented by 4 corners.
Definition: SBSCode.h:20
#define SBS_ENUM_BEGIN(name)
Definition: SBSCommon.h:16