SBSDKUIBarcodesBatchScannerBehaviorConfiguration
@interface SBSDKUIBarcodesBatchScannerBehaviorConfiguration : NSObject
Configuration for the behavior of barcodes.
-
Whether flash is toggled on or off.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite, getter=isFlashEnabled) BOOL flashEnabled;
Swift
var isFlashEnabled: Bool { get set }
-
Whether scanner screen should make a sound on successful barcode or MRZ detection.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite, getter=isSuccessBeepEnabled) BOOL successBeepEnabled;
Swift
var isSuccessBeepEnabled: Bool { get set }
-
The types of codes to be detected. The default value is nil, the common code types are being detected; see [SBSBDKBarcodeType commonTypes].
Declaration
Objective-C
@property (nonatomic, strong, nullable) NSArray<SBSDKBarcodeType *> *acceptedBarcodeTypes;
Swift
var acceptedBarcodeTypes: [SBSDKBarcodeType]? { get set }
-
The types of documents being extracted from scanned codes. The default value is nil, all document types are being extracted.
Declaration
Objective-C
@property (nonatomic, strong, nullable) NSArray<SBSDKBarcodeDocumentType *> *acceptedDocumentTypes;
Swift
var acceptedDocumentTypes: [SBSDKBarcodeDocumentType]? { get set }
-
Filter for extended EAN and UPC barcodes. By default the filter is disabled (SBSDKBarcodesExtensionFilterNoFilter).
Declaration
Objective-C
@property (nonatomic) SBSDKBarcodesExtensionFilter extensionFilter;
Swift
var extensionFilter: SBSDKBarcodesExtensionFilter { get set }
-
Additional parameters for tweaking the detection of barcodes.
Declaration
Objective-C
@property (nonatomic, strong, nonnull) SBSDKBarcodeAdditionalParameters *additionalDetectionParameters;
Swift
var additionalDetectionParameters: SBSDKBarcodeAdditionalParameters { get set }
-
The barcode detectors engine mode. The default value is SBSDKBarcodeEngineModeNextGen.
Declaration
Objective-C
@property (nonatomic) SBSDKBarcodeEngineMode engineMode;
Swift
var engineMode: SBSDKBarcodeEngineMode { get set }
-
The range of valid camera zoom factors. Default value is (1.0; 3.0).
Declaration
Objective-C
@property (nonatomic, strong, nonnull) SBSDKZoomRange *cameraZoomRange;
Swift
var cameraZoomRange: SBSDKZoomRange { get set }
-
The relative zoom level of the camera relative to
zoomRange
. The minimum value is 0.0 (zoomed out), the maximum value is 1.0 (zoomed in). The default value is 0.0, zoomed out.You can use this value to zoom the camera programmatically but also to set an initial zoom factor.
Declaration
Objective-C
@property (nonatomic) CGFloat cameraZoomFactor;
Swift
var cameraZoomFactor: CGFloat { get set }
-
When this property is set to YES, the zoom can be activated by double tapping somewhere in the receivers view. The default value is YES.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite, getter=isDoubleTapToZoomEnabled) BOOL doubleTapToZoomEnabled;
Swift
var isDoubleTapToZoomEnabled: Bool { get set }
-
When this property is set to YES, the zoom can be activated by a pinch gesture somewhere in the receivers view. The default value is YES.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite, getter=isPinchToZoomEnabled) BOOL pinchToZoomEnabled;
Swift
var isPinchToZoomEnabled: Bool { get set }
-
Defines, if zooming in or out should be animated. The default value is YES;
Declaration
Objective-C
@property (nonatomic) BOOL shouldAnimateZooming;
Swift
var shouldAnimateZooming: Bool { get set }
-
Additional filter to reject or accept barcode scanner results. The default value is an instance of SBSDKUIBarcodeFilter.
Declaration
Objective-C
@property (nonatomic, strong, nonnull) SBSDKUIBarcodeFilter *barcodeFilter;
Swift
var barcodeFilter: SBSDKUIBarcodeFilter { get set }
-
Disables auto-focus and locks the lens at the specified focus lock lens position. The default value is NO.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite, getter=isFocusLockEnabled) BOOL focusLockEnabled;
Swift
var isFocusLockEnabled: Bool { get set }
-
The position of the lens. Values can be between 0.0f (minimum focusing distance) and 1.0f (maximum focusing distance). The value will be clamped to [0.0f, 1.0f]. The default value is 0.0.
Declaration
Objective-C
@property (nonatomic) CGFloat focusLockPosition;
Swift
var focusLockPosition: CGFloat { get set }
-
The initial recognition delay in seconds. Defaults to 0.0.
Declaration
Objective-C
@property (nonatomic) NSTimeInterval initialScanDelay;
Swift
var initialScanDelay: TimeInterval { get set }
-
Set to YES to enable and display the region of interest, to NO otherwise. The default value is YES.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite, getter=isViewFinderEnabled) BOOL viewFinderEnabled;
Swift
var isViewFinderEnabled: Bool { get set }