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

SBSBarcodeGenerator.h
Go to the documentation of this file.
1 //
2 // SBSBarcodeGenerator.h
3 // ScanditBarcodeScanner
4 //
5 // Created by Tibor Molnár on 13/07/2018.
6 // Copyright © 2018 Scandit AG. All rights reserved.
7 //
8 
9 #import <UIKit/UIKit.h>
10 #import "SBSCode.h"
11 
17 SBS_ENUM_BEGIN(SBSGeneratorError){
18  SBSGeneratorErrorEmptyInput,
19  SBSGeneratorErrorInvalidOptionsObject,
20  SBSGeneratorErrorNullContextGiven
21 } SBS_ENUM_END(SBSGeneratorError);
22 
23 NS_ASSUME_NONNULL_BEGIN
24 
30 FOUNDATION_EXPORT NSString *const SBSGeneratorErrorDomain;
31 
32 @class SBSEncodingRange;
33 
39 @interface SBSBarcodeGenerator : NSObject
40 
51 - (nullable UIImage *)generateFromString:(nullable NSString *)string error:(NSError *_Nullable *_Nullable)outError;
52 
63 - (nullable UIImage *)generateFromData:(nullable NSData *)data error:(NSError *_Nullable *_Nullable)outError;
64 
76 - (nullable UIImage *)generateFromData:(nullable NSData *)data
77  encodings:(nullable NSArray<SBSEncodingRange *> *)encodings
78  error:(NSError *_Nullable *_Nullable)outError;
79 
90 - (BOOL)setOptions:(NSDictionary<NSString *, id> *)options error:(NSError *_Nullable *_Nullable)outError;
91 
92 @end
93 
94 NS_ASSUME_NONNULL_END
SBS_ENUM_END
#define SBS_ENUM_END(name)
Definition: SBSCommon.h:17
SBSGeneratorErrorNullContextGiven
Definition: SBSBarcodeGenerator.h:20
SBSGeneratorError
SBSGeneratorError
Definition: SBSBarcodeGenerator.h:17
SBSBarcodeGenerator
A barcode generator.
Definition: SBSBarcodeGenerator.h:39
SBSGeneratorErrorDomain
NS_ASSUME_NONNULL_BEGIN FOUNDATION_EXPORT NSString *const SBSGeneratorErrorDomain
The NSError domain of the SBSBarcodeGenerator related errors.
Definition: SBSBarcodeGenerator.h:30
SBSCode.h
SBSGeneratorErrorInvalidOptionsObject
Definition: SBSBarcodeGenerator.h:19
SBSEncodingRange
An encoding range for the barcode generator. Specifies the encoding and the start and end index of th...
Definition: SBSEncodingRange.h:19
SBSGeneratorErrorEmptyInput
Definition: SBSBarcodeGenerator.h:18
SBS_ENUM_BEGIN
#define SBS_ENUM_BEGIN(name)
Definition: SBSCommon.h:16
Copyright (C) 2019 Scandit AG