Barcode Count View

Defined in framework ScanditBarcodeCapture

SDCBarcodeCountViewStyle

Added in version 6.15.0

The style of the SDCBarcodeCountView

SDCBarcodeCountViewStyleIcon

Added in version 6.15.0

Style that draws the highlights as icons and adds an animation for when a code newly appears.

SDCBarcodeCountViewStyleDot

Added in version 6.15.0

Style that draws the highlights as a dot and adds an animation for when a code newly appears.

SDCBarcodeCountView

@interface SDCBarcodeCountView : UIView

Added in version 6.15.0

SDCBarcodeCount comes with a ready-to-use UI. Add SDCBarcodeCountView to the view hierarchy. Please note that this view should be presented full screen.

- initWithFrame:context:barcodeCount:

- (instancetype)initWithFrame:(CGRect)frame
                      context:(nonnull SDCDataCaptureContext *)context
                 barcodeCount:(nonnull SDCBarcodeCount *)barcodeCount

Added in version 6.15.0

Constructs a new barcode count view.

- initWithFrame:context:barcodeCount:style:

- (instancetype)initWithFrame:(CGRect)frame
                      context:(nonnull SDCDataCaptureContext *)context
                 barcodeCount:(nonnull SDCBarcodeCount *)barcodeCount
                        style:(SDCBarcodeCountViewStyle)style

Added in version 6.15.0

Constructs a new barcode count view.

- initWithFrame:context:barcodeCount:style:topLayoutAnchor:

- (instancetype)initWithFrame:(CGRect)frame
                      context:(nonnull SDCDataCaptureContext *)context
                 barcodeCount:(nonnull SDCBarcodeCount *)barcodeCount
                        style:(SDCBarcodeCountViewStyle)style
              topLayoutAnchor:(nullable NSLayoutYAxisAnchor *)topLayoutAnchor

Added in version 6.21.0

Constructs a new barcode count view. topLayoutAnchor can be used to specify the top vertical anchor the SDCBarcodeCountView should use to arrange its UI elements. If nil the anchor used will be the top of the view.

- prepareScanningWithContext:

- (void)prepareScanningWithContext:(SDCDataCaptureContext *)context

Added in version 6.18.0

Method to call for preparing the mode for scanning. For instance, it can be called when the view controller containing BarcodeCountView is about to be presented (i.e., UIViewController’s viewWillAppear).

override func viewWillAppear(animated: Bool) {
    super.viewWillAppear(animated)
    barcodeCountView.prepareScanning(with: context)
}

- stopScanning

- (void)stopScanning

Added in version 6.18.0

Method to call for stopping the mode. For instance, it can be called when the view controller containing BarcodeCountView is about to disappear (i.e., UIViewController’s viewWillDisappear).

override func viewWillDisappear(animated: Bool) {
    super.viewWillDisappear(animated)
    barcodeCountView.stopScanning()
}

shouldShowUserGuidanceView

@property (nonatomic, assign) BOOL shouldShowUserGuidanceView

Added in version 6.15.0

When set to YES, user guidance and the loading view will be shown to the user. The user guidance prompts the user to scan, and to move closer or further away from the target barcodes in order to scan them properly.

By default this property is YES.

shouldShowListButton

@property (nonatomic, assign) BOOL shouldShowListButton

Added in version 6.15.0

When set to YES, a list button will be shown to the user in the lower left hand corner of the screen. When tapped, this button will freeze the mode unless shouldDisableModeOnExitButtonTapped is set to NO. This button triggers a call to SDCBarcodeCountViewUIDelegate.listButtonTappedForBarcodeCountView:.

By default this property is YES.

shouldShowExitButton

@property (nonatomic, assign) BOOL shouldShowExitButton

Added in version 6.15.0

When set to YES, an exit button will be shown in the lower right hand corner of the screen. The behavior for this button is left entirely to the developer, and does nothing by default. When clicked, this button triggers a call to SDCBarcodeCountViewUIDelegate.exitButtonTappedForBarcodeCountView:.

By default this property is YES.

shouldShowShutterButton

@property (nonatomic, assign) BOOL shouldShowShutterButton

Added in version 6.15.0

When set to YES, a shutter button will be shown to the user centered in the bottom of the screen. This button triggers the processing of the current video feed. The same functionality can be triggered by calling SDCBarcodeCount.startScanningPhase.

By default this property is YES.

shouldShowHints

@property (nonatomic, assign) BOOL shouldShowHints

Added in version 6.15.0

When set to YES, this view will show some messages about currently scanned barcodes.

By default this property is YES.

shouldShowClearHighlightsButton

@property (nonatomic, assign) BOOL shouldShowClearHighlightsButton

Added in version 6.15.0

When set to YES, a button will be shown above the default shutter button. This button clears all currently shown barcodes highlights. The same functionality can be triggered by calling clearHighlights.

By default this property is NO.

shouldShowSingleScanButton

@property (nonatomic, assign) BOOL shouldShowSingleScanButton

Added in version 6.16.0

When set to YES, a button will be shown to the user in the lower left corner of the preview. The behavior for this button is left entirely to the developer, and does nothing by default. When clicked, this button triggers a call to SDCBarcodeCountViewUIDelegate.singleScanButtonTappedForBarcodeCountView:.

By default this property is NO.

shouldShowStatusModeButton

@property (nonatomic, assign) BOOL shouldShowStatusModeButton

Added in version 6.17.0

When set to YES, a button will be shown to the user in the lower right corner of the preview. This button toggles “status mode”, in which the normal barcode highlights will be replaced by status indicators for each barcode. The status for each barcode must be provided via a SDCBarcodeCountStatusProvider previously set with setStatusProvider:. If no SDCBarcodeCountStatusProvider is set, clicking this button has no effect.

By default this property is NO.

Note

The Barcode Count status mode API is still in beta and may change in future versions of Scandit Data Capture SDK.

shouldShowFloatingShutterButton

@property (nonatomic, assign) BOOL shouldShowFloatingShutterButton

Added in version 6.15.0

When set to YES, a floating shutter button will be visible on screen. This button can be dragged to any position and, when tapped, will trigger the processing of the current video feed.

By default this property is NO.

shouldShowToolbar

@property (nonatomic, assign) BOOL shouldShowToolbar

Added in version 6.16.0

When set to YES, a collapsable toolbar will be visible at the top of the preview. This toolbar contains a set of convenience buttons for easy preference setting during scanning.

By default this property is YES.

shouldDisableModeOnExitButtonTapped

@property (nonatomic, assign) BOOL shouldDisableModeOnExitButtonTapped

Added in version 6.17.0

When set to YES, the mode will disable automatically when the default exit button is tapped.

By default this property is YES.

- setToolbarSettings:

- (void)setToolbarSettings:(SDCBarcodeCountToolbarSettings *)settings

Added in version 6.16.0

Pass an instance of SDCBarcodeCountToolbarSettings to configure the text and accessibility options for the toolbar.

- setStatusProvider:

- (void)setStatusProvider:(id<SDCBarcodeCountStatusProvider>)statusProvider

Added in version 6.17.0

Sets a SDCBarcodeCountStatusProvider for this view. This provider will be queried when the “status mode” button is clicked.

Note

The Barcode Count status mode API is still in beta and may change in future versions of Scandit Data Capture SDK.

delegate

@property (nonatomic, weak, nullable) id<SDCBarcodeCountViewDelegate> delegate

Added in version 6.15.0

The delegate which is called whenever a new SDCTrackedBarcode is newly tracked or newly recognized.

Note

Using this delegate requires the MatrixScan AR add-on.

UIDelegate

@property (nonatomic, weak, nullable) id<SDCBarcodeCountViewUIDelegate> UIDelegate

Added in version 6.15.0

The delegate which is called whenever the exit or list button of the view did receive a tap.

Note

Using this delegate requires the MatrixScan AR add-on.

defaultRecognizedBrush

@property (class, nonatomic, nonnull, readonly) SDCBrush *defaultRecognizedBrush

Added in version 6.15.0

Returns the default brush to use for a recognized barcode. When setting a SDCBarcodeCountCaptureList to the mode, this brush will be used for recognized barcodes that are part of the target list. Only used when setting the view style to SDCBarcodeCountViewStyleDot.

defaultUnrecognizedBrush

@property (class, nonatomic, nonnull, readonly) SDCBrush *defaultUnrecognizedBrush

Added in version 6.15.0

Returns the default brush to use for an unrecognized barcode. Only used when setting the view style to SDCBarcodeCountViewStyleDot.

defaultNotInListBrush

@property (class, nonatomic, nonnull, readonly) SDCBrush *defaultNotInListBrush

Added in version 6.15.0

Returns the default brush to use for a recognized barcode that’s not part of the target SDCBarcodeCountCaptureList. When SDCBarcodeCountCaptureList is not set, this method will never be called. Only used when setting the view style to SDCBarcodeCountViewStyleDot.

recognizedBrush

@property (nonatomic, strong, nullable) SDCBrush *recognizedBrush

Added in version 6.15.0

The brush applied to recognized tracked barcodes if SDCBarcodeCountViewDelegate is not implemented. When setting a SDCBarcodeCountCaptureList to the mode, this brush will be used for recognized barcodes that are part of the target list. Setting this brush to nil hides all tracked barcodes.

unrecognizedBrush

@property (nonatomic, strong, nullable) SDCBrush *unrecognizedBrush

Added in version 6.15.0

The brush applied to unrecognized tracked barcodes if SDCBarcodeCountViewDelegate is not implemented. Setting this brush to nil hides all tracked barcodes.

notInListBrush

@property (nonatomic, strong, nullable) SDCBrush *notInListBrush

Added in version 6.15.0

The brush applied to recognized tracked barcodes that are not part of the target SDCBarcodeCountCaptureList, and only if SDCBarcodeCountViewDelegate is not implemented. When SDCBarcodeCountCaptureList is not set, this method will never be called. Setting this brush to nil hides all tracked barcodes.

shouldShowScanAreaGuides

@property (nonatomic, assign) BOOL shouldShowScanAreaGuides

Added in version 6.15.0

When set to YES, this view will visualize the active scan area used for BarcodeCount. This is useful to check margins defined on the SDCDataCaptureView are set correctly. This property is meant for debugging during development and is not intended for use in production.

By default this property is NO.

style

@property (nonatomic, readonly) SDCBarcodeCountViewStyle style

Added in version 6.15.0

The view style. Defaults to SDCBarcodeCountViewStyleDot.

listButtonAccessibilityLabel

@property (nonatomic, strong, nullable) NSString *listButtonAccessibilityLabel

Added in version 6.15.0

Use this property to access or modify the accessibility label for the list button provided by the view.

exitButtonAccessibilityLabel

@property (nonatomic, strong, nullable) NSString *exitButtonAccessibilityLabel

Added in version 6.15.0

Use this property to access or modify the accessibility label for the exit button provided by the view.

shutterButtonAccessibilityLabel

@property (nonatomic, strong, nullable) NSString *shutterButtonAccessibilityLabel

Added in version 6.15.0

Use this property to access or modify the accessibility label for the shutter button provided by the view.

floatingShutterButtonAccessibilityLabel

@property (nonatomic, strong, nullable) NSString *floatingShutterButtonAccessibilityLabel

Added in version 6.15.0

Use this property to access or modify the accessibility label for the floating shutter button provided by the view.

singleScanButtonAccessibilityLabel

@property (nonatomic, strong, nullable) NSString *singleScanButtonAccessibilityLabel

Added in version 6.16.0

Use this property to access or modify the accessibility label for the single scan button provided by the view.

clearHighlightsButtonAccessibilityLabel

@property (nonatomic, strong, nullable) NSString *clearHighlightsButtonAccessibilityLabel

Added in version 6.15.0

Use this property to access or modify the accessibility label for the clear highlights button provided by the view.

statusModeButtonAccessibilityLabel

@property (nonatomic, strong, nullable) NSString *statusModeButtonAccessibilityLabel

Added in version 6.17.0

Use this property to access or modify the accessibility label for the single status mode button provided by the view.

listButtonAccessibilityHint

@property (nonatomic, strong, nullable) NSString *listButtonAccessibilityHint

Added in version 6.15.0

Use this property to access or modify the accessibility hint for the list button provided by the view.

exitButtonAccessibilityHint

@property (nonatomic, strong, nullable) NSString *exitButtonAccessibilityHint

Added in version 6.15.0

Use this property to access or modify the accessibility hint for the exit button provided by the view.

shutterButtonAccessibilityHint

@property (nonatomic, strong, nullable) NSString *shutterButtonAccessibilityHint

Added in version 6.15.0

Use this property to access or modify the accessibility hint for the shutter button provided by the view.

floatingShutterButtonAccessibilityHint

@property (nonatomic, strong, nullable) NSString *floatingShutterButtonAccessibilityHint

Added in version 6.15.0

Use this property to access or modify the accessibility hint for the floating shutter button provided by the view.

clearHighlightsButtonAccessibilityHint

@property (nonatomic, strong, nullable) NSString *clearHighlightsButtonAccessibilityHint

Added in version 6.15.0

Use this property to access or modify the accessibility hint for the clear highlights button provided by the view.

singleScanButtonAccessibilityHint

@property (nonatomic, strong, nullable) NSString *singleScanButtonAccessibilityHint

Added in version 6.16.0

Use this property to access or modify the accessibility hint for the single scan button provided by the view.

statusModeButtonAccessibilityHint

@property (nonatomic, strong, nullable) NSString *statusModeButtonAccessibilityHint

Added in version 6.17.0

Use this property to access or modify the accessibility hint for the status mode button provided by the view.

- setClearHighlightsButtonText:

- (void)setClearHighlightsButtonText:(nonnull NSString *)text

Added in version 6.15.0

Use this method to modify the text of the clear button label provided by the view.

- clearHighlightsButtonText

- (NSString *)clearHighlightsButtonText

Added in version 6.17.0

Returns the text of the clear button label provided by the view.

- setTextForUnrecognizedBarcodesDetectedHint:

- (void)setTextForUnrecognizedBarcodesDetectedHint:(nonnull NSString *)text

Added in version 6.15.0

Sets the text of the hint displayed when one or more unrecognized barcodes are detected.

- textForUnrecognizedBarcodesDetectedHint

- (NSString *)textForUnrecognizedBarcodesDetectedHint

Added in version 6.17.0

Returns the text of the hint displayed when one or more unrecognized barcodes are detected.

- setTextForTapShutterToScanHint:

- (void)setTextForTapShutterToScanHint:(nonnull NSString *)text

Added in version 6.15.0

Sets the text of the hint which suggests to tap the shutter button.

- textForTapShutterToScanHint

- (NSString *)textForTapShutterToScanHint

Added in version 6.17.0

Returns the text of the hint which suggests to tap the shutter button.

- setTextForScanningHint:

- (void)setTextForScanningHint:(nonnull NSString *)text

Added in version 6.15.0

Sets the text of the hint displayed while scanning is in progress.

- textForScanningHint

- (NSString *)textForScanningHint

Added in version 6.17.0

Returns the text of the hint displayed while scanning is in progress.

- setTextForMoveCloserAndRescanHint:

- (void)setTextForMoveCloserAndRescanHint:(nonnull NSString *)text

Added in version 6.15.0

Sets the text of the hint displayed when camera should be moved closer to rescan.

- textForMoveCloserAndRescanHint

- (NSString *)textForMoveCloserAndRescanHint

Added in version 6.17.0

Returns the text of the hint displayed when camera should be moved closer to rescan.

- setTextForMoveFurtherAndRescanHint:

- (void)setTextForMoveFurtherAndRescanHint:(nonnull NSString *)text

Added in version 6.15.0

Sets the text of the hint displayed when camera should be further away to rescan.

- textForMoveFurtherAndRescanHint

- (NSString *)textForMoveFurtherAndRescanHint

Added in version 6.17.0

Returns the text of the hint displayed when camera should be further away to rescan.

- setTextForBarcodesNotInListDetectedHint:

- (void)setTextForBarcodesNotInListDetectedHint:(nonnull NSString *)text

Added in version 6.23.0

Sets the text of the hint displayed when a barcode not in list is scanned.

- textForBarcodesNotInListDetectedHint

- (NSString *)textForBarcodesNotInListDetectedHint

Added in version 6.23.0

Returns the text of the hint displayed when a barcode not in list is scanned.

- setExitButtonText:

- (void)setExitButtonText:(nonnull NSString *)text

Added in version 6.15.0

Use this method to modify the text of the exit button label provided by the view.

- exitButtonText

- (NSString *)exitButtonText

Added in version 6.17.0

Returns the text of the exit button label provided by the view.

filterSettings

@property (nonatomic, strong, nullable) id<SDCBarcodeFilterHighlightSettings> filterSettings

Added in version 6.15.0

Use this property to access or modify the current view settings for barcode filtering.

- clearHighlights

- (void)clearHighlights

Added in version 6.15.0

Clear all currently shown barcodes highlights. This only affects screen rendering, and all detected barcodes will still be available in the SDCBarcodeCountSession.

- setBrush:forRecognizedBarcode:

- (void)setBrush:(nullable SDCBrush *)brush
forRecognizedBarcode:(SDCTrackedBarcode *)barcode

Added in version 6.18.0

Set a SDCBrush to be used for a particular recognized SDCTrackedBarcode. This will override any other applicable brush for this particular barcode.

- setBrush:forUnrecognizedBarcode:

- (void)setBrush:(nullable SDCBrush *)brush
forUnrecognizedBarcode:(SDCTrackedBarcode *)barcode

Added in version 6.18.0

Set a SDCBrush to be used for a particular unrecognized SDCTrackedBarcode. This will override any other applicable brush for this particular barcode.

- setBrush:forRecognizedBarcodeNotInList:

- (void)setBrush:(nullable SDCBrush *)brush
forRecognizedBarcodeNotInList:(SDCTrackedBarcode *)barcode

Added in version 6.18.0

Set a SDCBrush to be used for a particular recognized SDCTrackedBarcode that doesn’t belong to the capture list. This will only be applicable when using a capture list, and will override any other applicable brush for this particular barcode.

hardwareTriggerEnabled

@property (nonatomic, assign) BOOL hardwareTriggerEnabled

Added in version 6.23.0

Enables the SDCBarcodeCountView to react to clicks of the volume button.

SDCBarcodeCountViewStyleToString(style)

NSString *_Nonnull SDCBarcodeCountViewStyleToString(SDCBarcodeCountViewStyle style)

Added in version 6.17.0

SDCBarcodeCountViewStyleFromString(value)

SDCBarcodeCountViewStyle SDCBarcodeCountViewStyleFromString(NSString *_Nonnull value)

Added in version 6.18.0