Barcode Sequence View

Defined in framework ScanditBarcodeCapture

BarcodeSequenceViewUIDelegate

protocol BarcodeSequenceViewUIDelegate : NSObjectProtocol

Added in version 8.1.0

barcodeSequenceView

optional func barcodeSequenceView(_ view: BarcodeSequenceView, didTapNextButton sequencedShelfModule: SequencedShelfModule?) -> Void

Added in version 8.1.0

Callback method that is called when the next button is tapped in the view with the sequenced shelf module. Module may be null.

barcodeSequenceView

optional func barcodeSequenceView(_ view: BarcodeSequenceView, didTapViewListButton sequencedShelfModule: SequencedShelfModule?) -> Void

Added in version 8.1.0

Callback method that is called when the view list button is tapped in the view with the sequenced shelf module. Module may be null.

BarcodeSequenceView

open class BarcodeSequenceView : UIView

Added in version 8.1.0

Barcode Sequence comes with a ready-to-use UI that allows highlighting barcodes and trays and building a shelf module. The BarcodeSequenceView integrates with any app in just a few lines of code.

init

init(parentView: UIView, barcodeSequence: BarcodeSequence, settings: BarcodeSequenceViewSettings, cameraSettings: CameraSettings?)

Added in version 8.1.0

Creates a new BarcodeSequenceView with the provided mode, view settings, camera settings.

init

init(parentView: UIView, barcodeSequence: BarcodeSequence, settings: BarcodeSequenceViewSettings)

Added in version 8.1.0

Creates a new BarcodeSequenceView with the provided mode, view settings, and default camera settings from BarcodeSequence.recommendedCameraSettings().

uiDelegate

open weak var uiDelegate: BarcodeSequenceViewUIDelegate? { get, set }

Added in version 8.1.0

Sets the listener which is called whenever buttons are tapped in the view.

shouldShowTorchControl

open var shouldShowTorchControl: Bool { get, set }

Added in version 8.1.0

Indicates whether the torch control button should be shown.

Default is true.

torchControlPosition

open var torchControlPosition: Anchor { get, set }

Added in version 8.1.0

Updates the position of the torch control button.

Default is Anchor.topLeft.

initialGuidanceTitleText

open var initialGuidanceTitleText: String { get, set }

Added in version 8.1.0

The title text for the initial guidance tutorial dialog.

Default is “Scan all codes in a shelf”.

initialGuidanceDescriptionText

open var initialGuidanceDescriptionText: String { get, set }

Added in version 8.1.0

The description text for the initial guidance tutorial dialog.

Default is “For best results, use landscape mode and scan each row from left to right pausing in between rows.”.

initialGuidanceButtonText

open var initialGuidanceButtonText: String { get, set }

Added in version 8.1.0

The button text for the initial guidance tutorial dialog.

Default is “OK”.

rotateDeviceToCaptureText

open var rotateDeviceToCaptureText: String { get, set }

Added in version 8.1.0

The text displayed in the rotation prompt when the device needs to be rotated to landscape mode for sequencing.

Default is “Rotate to landscape to capture”.

pointShelfToCaptureText

open var pointShelfToCaptureText: String { get, set }

Added in version 8.1.0

The text displayed in the rotation prompt when the device is not facing the shelf and needs to be rotated towards it for sequencing.

Default is “Point the shelf to capture”.

shouldShowViewListButton

open var shouldShowViewListButton: Bool { get, set }

Added in version 8.1.0

Whether the View List button is shown.

Default is true.

shouldShowNextButton

open var shouldShowNextButton: Bool { get, set }

Added in version 8.1.0

Whether the Next button is shown.

Default is true.

shouldShowRedoButton

open var shouldShowRedoButton: Bool { get, set }

Added in version 8.1.0

Whether the Redo button is shown.

Default is true.

nextButtonText

open var nextButtonText: String { get, set }

Added in version 8.1.0

The text for the Next button.

Default is “Next”.

redoButtonText

open var redoButtonText: String { get, set }

Added in version 8.1.0

The text for the Redo button.

Default is “Redo”.

viewListButtonText

open var viewListButtonText: String { get, set }

Added in version 8.1.0

The text for the View List button.

Default is “View List”.

redoShelfDialogTitleText

open var redoShelfDialogTitleText: String { get, set }

Added in version 8.1.0

The title text for the redo confirmation dialog.

Default is “Redo Shelf”.

redoShelfDialogDescriptionText

open var redoShelfDialogDescriptionText: String { get, set }

Added in version 8.1.0

The description text for the redo confirmation dialog.

Default is “Your current capture will be cleared. Do you want to start a new capture?”.

redoShelfDialogAcceptButtonText

open var redoShelfDialogAcceptButtonText: String { get, set }

Added in version 8.1.0

The accept button text for the redo confirmation dialog.

Default is “Redo”.

redoShelfDialogCancelButtonText

open var redoShelfDialogCancelButtonText: String { get, set }

Added in version 8.1.0

The cancel button text for the redo confirmation dialog.

Default is “Cancel”.

removeBarcodeButtonText

open var removeBarcodeButtonText: String { get, set }

Added in version 8.1.0

The text for the remove barcode button in popover annotation.

Default is “Remove”.

addBarcodeButtonText

open var addBarcodeButtonText: String { get, set }

Added in version 8.1.0

The text for the add barcode button in popover annotation.

Default is “Add”.

start

open func start() -> Void

Added in version 8.1.0

This method starts the camera but does not begin the sequencing process. The sequencing process will start when the user taps the shutter button.

pause

open func pause() -> Void

Added in version 8.1.0

Pauses the sequencing process but keeps the camera running. It can be started again using start().

stop

open func stop() -> Void

Added in version 8.1.0

Stops the camera and the sequencing process. It can be started again using start().

reset

open func reset() -> Void

Added in version 8.1.0

Clears UI state and resets the view.