Barcode Find View

Defined in package com.scandit.datacapture.barcode.find.ui

BarcodeFindViewUiListener

interface BarcodeFindViewUiListener

Added in version 6.18.0

onFinishButtonTapped(foundItems)

fun onFinishButtonTapped(foundItems: Set<BarcodeFindItem>)

Added in version 6.18.0

Callback method that can be used to define an action that should be performed when the finish button is tapped from the view. The foundItems parameter contains all the items found since the start of the searching process. Called from the main thread.

BarcodeFindView

class BarcodeFindView : RelativeLayout

Added in version 6.18.0

BarcodeFind comes with a ready-to-use search UI that uses augmented reality overlays to highlight items that match predefined criteria. The BarcodeFindView integrates with any app in just a few lines of code.

newInstance(parentView, dataCaptureContext, barcodeFind, settings)

fun BarcodeFindView.newInstance(parentView: View,
        dataCaptureContext: DataCaptureContext,
        barcodeFind: BarcodeFind,
        settings: BarcodeFindViewSettings): BarcodeFindView

Added in version 6.18.0

Constructs a new BarcodeFind view and adds it to the provided parentView. The provided settings will be used to set the default behaviour and look of the view.

newInstance(parentView, dataCaptureContext, barcodeFind, settings, cameraSettings)

fun BarcodeFindView.newInstance(parentView: View,
        dataCaptureContext: DataCaptureContext,
        barcodeFind: BarcodeFind,
        settings: BarcodeFindViewSettings,
        cameraSettings: CameraSettings): BarcodeFindView

Added in version 6.18.0

Constructs a new BarcodeFind view and adds it to the provided parentView.

The provided settings will be used to set the default behaviour and look of the view.

The provided camera settings will be used instead of the recommended camera settings for BarcodeFind.

newInstance(parentView, dataCaptureContext, barcodeFind)

fun BarcodeFindView.newInstance(parentView: View,
        dataCaptureContext: DataCaptureContext,
        barcodeFind: BarcodeFind): BarcodeFindView

Added in version 6.18.0

Constructs a new BarcodeFind view and adds it to the provided parentView. The view will use default settings.

newInstance(dataCaptureView, dataCaptureContext, barcodeFind, settings, cameraSettings)

fun BarcodeFindView.newInstance(dataCaptureView: DataCaptureView,
        dataCaptureContext: DataCaptureContext,
        barcodeFind: BarcodeFind,
        settings: BarcodeFindViewSettings,
        cameraSettings: CameraSettings): BarcodeFindView

Added in version 6.19.0

Constructs a new BarcodeFind view.

Warning

This constructor method should only be used in special cases, and its use is not recommended.

The newly created BarcodeFind view will need to be manually added to the view hierarchy.

onResume()

fun onResume()

Added in version 6.18.0

Function to call on Fragment/Activity onResume callback. You have to call this for the correct functioning of the BarcodeFindView.

onPause()

fun onPause()

Added in version 6.18.0

Function to call on Fragment/Activity onPause callback. You have to call this for the correct functioning of the BarcodeFindView.

Since this method effectively removes the BarcodeFind mode from the DataCaptureContext, any calls to BarcodeFind.stop() must be done before calling OnPause.

stopSearching()

fun stopSearching()

Added in version 6.18.0

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

startSearching()

fun startSearching()

Added in version 6.18.0

Starts the searching process. You can call this method if you want to trigger the searching process without any user interaction.

pauseSearching()

fun pauseSearching()

Added in version 6.18.0

Pauses the searching process. You can call this method if you want to trigger pausing the searching process without any user interaction.

setListener(listener)

fun setListener(listener: BarcodeFindViewUiListener?)

Added in version 6.18.0

Sets the listener which is called whenever the finish button is tapped from the view.

shouldShowUserGuidanceView

var shouldShowUserGuidanceView: Boolean

Added in version 6.18.0

Indicates whether guidance should be shown to the user.

Default is true.

shouldShowHints

var shouldShowHints: Boolean

Added in version 6.18.0

Indicates whether hints should be shown to the user.

Default is true.

shouldShowCarousel

var shouldShowCarousel: Boolean

Added in version 6.18.0

Indicates whether the item carousel should be shown to the user.

Default is true.

shouldShowPauseButton

var shouldShowPauseButton: Boolean

Added in version 6.18.0

Indicates whether the pause button should be shown to the user.

Default is true.

shouldShowFinishButton

var shouldShowFinishButton: Boolean

Added in version 6.18.0

Indicates whether the finish button should be shown to the user.

Default is true.

shouldShowProgressBar

var shouldShowProgressBar: Boolean

Added in version 6.18.0

Indicates whether the progress bar should be shown to the user.

Default is false.

shouldShowTorchControl

var shouldShowTorchControl: Boolean

Added in version 6.19.0

Indicates whether the torch control button should be shown to the user.

Default is false.

torchControlPosition

var torchControlPosition: Anchor

Added in version 6.19.0

Updates the position of the torch control button.

Only Anchor.TOP_LEFT, Anchor.TOP_CENTER, Anchor.TOP_RIGHT and Anchor.BOTTOM_LEFT are supported.

Any other value will default to Anchor.TOP_LEFT.

shouldShowZoomControl

var shouldShowZoomControl: Boolean

Added in version 6.28.0

Indicates whether the zoom control should be shown to the user, allowing them to switch between the normal and ultra-wide lenses.

Default is false.

Note

The zoom control requires a device with an ultra-wide camera. On devices without an ultra-wide camera, setting this property to true has no effect.

textForCollapseCardsButton

var textForCollapseCardsButton: String?

Added in version 6.18.0

Overrides the default text displayed in the button for collapsing the item carousel.

Default is null.

textForAllItemsFoundSuccessfullyHint

var textForAllItemsFoundSuccessfullyHint: String?

Added in version 6.18.0

Overrides the default text displayed in the green confirmation view shown when all items have been found.

Default is null.

textForPointAtBarcodesToSearchHint

var textForPointAtBarcodesToSearchHint: String?

Added in version 6.18.0

Overrides the default text for the “Point at barcodes to search” hint.

Default is null.

textForMoveCloserToBarcodesHint

var textForMoveCloserToBarcodesHint: String?

Added in version 6.18.0

Overrides the default text for the “Move closer” hint.

Default is null.

textForTapShutterToPauseScreenHint

var textForTapShutterToPauseScreenHint: String?

Added in version 6.18.0

Overrides the default text for “Tap shutter to pause” hint.

Default is null.

textForTapShutterToResumeSearchHint

var textForTapShutterToResumeSearchHint: String?

Added in version 6.18.0

Overrides the default text for “Tap shutter to resume” hint.

Default is null.

textForItemListUpdatedHint

var textForItemListUpdatedHint: String?

Added in version 6.24.0

Overrides the default text displayed in the confirmation view shown when the item list has been updated.

Default is null.

textForItemListUpdatedWhenPausedHint

var textForItemListUpdatedWhenPausedHint: String?

Added in version 6.24.0

Overrides the default text displayed in the confirmation view shown when the item list has been updated and search is paused.

Default is null.

camera

val camera: Camera?

Added in version 6.18.0

Returns the :type core.Camera associated with the current find scenario.

hardwareTriggerSupported

val BarcodeFindView.hardwareTriggerSupported: Boolean

Added in version 6.23.0

Returns whether the device supports listening for hardware button events. This is true for devices with api >= 28.