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 
39 
40 
50  SBSSymbologyUnknown = 0x0000000,
54  SBSSymbologyEAN13 = 0x0000001,
58  SBSSymbologyUPC12 = 0x0000004,
62  SBSSymbologyUPCE = 0x0000008,
66  SBSSymbologyCode39 = 0x0000020,
70  SBSSymbologyPDF417 = 0x0000400,
78  SBSSymbologyQR = 0x0000100,
83  SBSSymbologyITF = 0x0000080,
88  SBSSymbologyCode128 = 0x0000010,
92  SBSSymbologyCode93 = 0x0000040,
108  SBSSymbologyCodabar = 0x0004000,
112  SBSSymbologyEAN8 = 0x0000002,
116  SBSSymbologyAztec = 0x0008000,
142  SBSSymbologyCode11 = 0x0080000,
148  SBSSymbologyMaxiCode = 0x0040000,
149 
163  SBSSymbologyCode25 = 0x0200000,
164 
171 
177  SBSSymbologyRM4SCC = 0x0800000,
183  SBSSymbologyKIX = 0x1000000,
185 
186 
197  SBSCompositeFlagNone = 0x0000000,
222 
223 
230 @interface SBSCode : NSObject
231 
245 @property (nonnull, nonatomic, readonly) NSString *symbologyString;
246 
257 @property (nonnull, nonatomic, readonly) NSString * symbologyName;
258 
264 @property (nonatomic, readonly) SBSSymbology symbology;
265 
266 
277 @property (nullable, nonatomic, readonly) NSString *data;
278 
286 @property (nullable, nonatomic, readonly) NSData *rawData;
287 
298 @property (nonatomic, readonly) BOOL isRecognized;
299 
311 @property (nonatomic, readonly) SBSQuadrilateral location;
312 
321 @property (nonatomic, readonly) BOOL isGs1DataCarrier;
322 
330 @property (nonatomic, readonly) int symbolCount;
331 
338 @property (nonatomic, readonly) SBSCompositeFlag compositeFlag;
339 
340 
341 @end
Definition: SBSCode.h:104
BOOL isRecognized
Whether the code was completely recognized.
Definition: SBSCode.h:298
NSString * symbologyName
The symbology name of the barcode as a string.
Definition: SBSCode.h:257
NSData * rawData
The raw byte data contained in the barcode.
Definition: SBSCode.h:286
SBSSymbology symbology
Returns the symbology of a recognized barcode.
Definition: SBSCode.h:264
Definition: SBSCode.h:197
Definition: SBSCode.h:54
BOOL isGs1DataCarrier
Whether the code is a GS1 data carrier.
Definition: SBSCode.h:321
Represents a recognized/localized barcode/2D code.
Definition: SBSCode.h:230
Definition: SBSCode.h:88
int symbolCount
The symbol count of this barcode.
Definition: SBSCode.h:330
NSString * symbologyString
The symbology of the barcode as a string, including GS1 data carrier states.
Definition: SBSCode.h:245
SBSQuadrilateral location
The location of the code in the image.
Definition: SBSCode.h:311
Definition: SBSCode.h:208
Definition: SBSCode.h:66
Definition: SBSCode.h:70
#define SBS_ENUM_END(name)
Definition: SBSCommon.h:17
Definition: SBSCode.h:155
Definition: SBSCode.h:74
Definition: SBSCode.h:116
Sentinel value to represent an unknown symbology.
Definition: SBSCode.h:50
Definition: SBSCode.h:212
SBSSymbology
Enumerates the symbologies supported by Scandit Barcode Scanner.
Definition: SBSCode.h:46
CGPoint topRight
The top-right corner.
Definition: SBSCode.h:28
Definition: SBSCode.h:163
Definition: SBSCode.h:203
Definition: SBSCode.h:108
Definition: SBSCode.h:177
Definition: SBSCode.h:170
Definition: SBSCode.h:78
SBSCompositeFlag
Flags to hint that two codes form a composite code.
Definition: SBSCode.h:193
Definition: SBSCode.h:126
Definition: SBSCode.h:183
Definition: SBSCode.h:136
Definition: SBSCode.h:112
NSString * data
The data contained in the barcode/2D code, e.g. the 13 digit number of a EAN-13 code.
Definition: SBSCode.h:277
CGPoint bottomLeft
The bottom-left corner.
Definition: SBSCode.h:36
Definition: SBSCode.h:58
Definition: SBSCode.h:148
Definition: SBSCode.h:220
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:338
Definition: SBSCode.h:100
Definition: SBSCode.h:83
Definition: SBSCode.h:216
CGPoint bottomRight
The bottom-right corner.
Definition: SBSCode.h:32
Definition: SBSCode.h:142
Definition: SBSCode.h:92
Definition: SBSCode.h:96
Definition: SBSCode.h:62
Quadrilateral represented by 4 corners.
Definition: SBSCode.h:20
#define SBS_ENUM_BEGIN(name)
Definition: SBSCommon.h:16