Barcode Capture Overlay#
Defined in framework ScanditBarcodeCapture
-
SDCBarcodeCaptureOverlay
# @interface SDCBarcodeCaptureOverlay : NSObject <SDCDataCaptureOverlay>
Added in version 6.0.0
Overlay for the SDCBarcodeCapture capture mode that displays recognized barcodes on top of a data capture view. The appearance of the visualized barcodes can be configured or turned off completely through the brush property.
-
+ overlayWithBarcodeCapture:forDataCaptureView:
# + (
instancetype
)overlayWithBarcodeCapture:(nonnull SDCBarcodeCapture *)barcodeCapture forDataCaptureView:(nullable SDCDataCaptureView *)viewAdded in version 6.0.0
Constructs a new barcode capture overlay for the provided barcode capture instance. When passing a non-nil view instance, the overlay is automatically added to the view.
-
+ barcodeCaptureOverlayFromJSONString:mode:error:
# + (nullable
instancetype
)barcodeCaptureOverlayFromJSONString:(nonnull NSString *)jsonString mode:(nonnull SDCBarcodeCapture *)mode error:(NSError **)errorAdded in version 6.0.0
Constructs a new barcode capture overlay with the provided JSON serialization. See Serialization for details.
For the overlay to be displayed on screen, it must be added to a SDCDataCaptureView.
-
+ overlayWithBarcodeCapture:
# + (
instancetype
)overlayWithBarcodeCapture:(nonnull SDCBarcodeCapture *)barcodeCaptureAdded in version 6.0.0
Constructs a new barcode capture overlay for the provided barcode capture instance. For the overlay to be displayed on screen, it must be added to a SDCDataCaptureView.
-
viewfinder
# @property (nonatomic, strong, nullable)
id
<SDCViewfinder> viewfinderAdded in version 6.0.0
Set the viewfinder. By default, the viewfinder is nil. Set this to an instance of SDCViewfinder if you want to draw a viewfinder.
-
brush
# @property (nonatomic, strong, nonnull) SDCBrush *brush
Added in version 6.0.0
The brush used for visualizing a recognized barcode in the UI. To turn off drawing of locations, set the brush to use both a transparent fill and stroke color. By default, the brush has a transparent fill color, a “Scandit”-blue stroke color, and a stroke width of 1.
-
defaultBrush
# @property (class, nonatomic, nonnull, readonly) SDCBrush *defaultBrush
Added in version 6.0.0
Returns the default brush used by the overlay.
-
shouldShowScanAreaGuides
# @property (nonatomic, assign)
BOOL
shouldShowScanAreaGuidesAdded in version 6.0.0
Whether to show scan area guides on top of the preview. This property is useful during development to visualize the current scan areas on screen. It is not meant to be used for production. By default this property is NO.
-
- updateFromJSONString:error:
# - (
BOOL
)updateFromJSONString:(nonnull NSString *)jsonString error:(NSError **)errorAdded in version 6.0.0
Updates the overlay according to a JSON serialization. See Serialization for details.
-
- setValue:forProperty:
# - (
void
)setValue:(nullableid
)value forProperty:(nonnull NSString *)propertyAdded in version 6.0.0
Set barcode capture overlay property to the provided value. Use this method to set properties that are not yet part of a stable API. Properties set through this method may or may not be used or change in a future release.
-