Barcode AR View

Defined in library scandit_datacapture_barcode_ar_ui

BarcodeArViewUiListener

abstract class BarcodeArViewUiListener

Added in version 7.1.0

didTapHighlightForBarcode(barcodeAr, barcode, highlight)

void didTapHighlightForBarcode(BarcodeAr barcodeAr,
        Barcode barcode,
        BarcodeArHighlight highlight)

Added in version 7.1.0

Callback method that is called when a barcode highlight is tapped in the view.

BarcodeArView

class BarcodeArView : StatefulWidget

Added in version 7.1.0

Barcode AR comes with a ready-to-use UI that allows highlighting barcodes and displaying additional information over them. The BarcodeArView integrates with any app in just a few lines of code.

BarcodeArView.forMode(dataCaptureContext, barcodeAr)

factory BarcodeArView.forMode(DataCaptureContext dataCaptureContext,
        BarcodeAr barcodeAr)

Added in version 7.1.0

Creates a new BarcodeArView with the provided mode, viewSettings and cameraSettings.

BarcodeArView.forModeWithViewSettingsAndCameraSettings(dataCaptureContext, barcodeAr, viewSettings, cameraSettings)

factory BarcodeArView.forModeWithViewSettingsAndCameraSettings(
        DataCaptureContext dataCaptureContext,
        BarcodeAr barcodeAr,
        BarcodeArViewSettings viewSettings,
        CameraSettings cameraSettings)

Added in version 7.1.0

Creates a new BarcodeArView with the provided mode, viewSettings and cameraSettings.

BarcodeArView.forModeWithViewSettings(dataCaptureContext, barcodeAr, viewSettings)

factory BarcodeArView.forModeWithViewSettings(
        DataCaptureContext dataCaptureContext,
        BarcodeAr barcodeAr,
        BarcodeArViewSettings viewSettings)

Added in version 7.1.0

Creates a new BarcodeArView with the provided mode, viewSettings and default camera settings from BarcodeAr.createRecommendedCameraSettings(). This is equivalent of calling forMode() with null cameraSettings.

uiListener

BarcodeArViewUiListener? uiListener

Added in version 7.1.0

Sets the listener which is called whenever a barcode highlight is tapped in the view.

highlightProvider

BarcodeArHighlightProvider? highlightProvider

Added in version 7.1.0

Sets the provider which supplies highlight information for barcodes in the view. If null, a default provider is used, which returns a predefined highlight for each barcode.

annotationProvider

BarcodeArAnnotationProvider? annotationProvider

Added in version 7.1.0

Sets the provider which supplies annotation information for barcodes in the view. If null, no annotation will be displayed for any barcode.

shouldShowTorchControl

bool shouldShowTorchControl

Added in version 7.1.0

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

Default is false.

torchControlPosition

Anchor torchControlPosition

Added in version 7.1.0

Updates the position of the torch control button.

Default is Anchor.topLeft.

torchControlOffset

PointWithUnit? torchControlOffset

Added in version 8.6.0

Sets the visual offset of the torch control button.

shouldShowZoomControl

bool shouldShowZoomControl

Added in version 7.1.0

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

zoomControlPosition

Anchor zoomControlPosition

Added in version 7.1.0

Updates the position of the zoom control button.

Default is Anchor.bottomRight.

zoomControlOffset

PointWithUnit? zoomControlOffset

Added in version 8.6.0

Sets the visual offset of the zoom control button.

shouldShowCameraSwitchControl

bool shouldShowCameraSwitchControl

Added in version 7.1.0

Indicates whether the camera switch control button should be shown to the user.

cameraSwitchControlPosition

Anchor cameraSwitchControlPosition

Added in version 7.1.0

Updates the position of the camera switch control button.

Default is Anchor.topRight.

cameraSwitchControlOffset

PointWithUnit? cameraSwitchControlOffset

Added in version 8.6.0

Sets the visual offset of the camera switch control button.

logoStyle

LogoStyle logoStyle

Added in version 8.6.0

The style of the logo, either the extended “Scanning By Scandit” or the minimal “Scandit”.

Default is LogoStyle.extended.

logoAnchor

Anchor logoAnchor

Added in version 8.6.0

The anchor point used to position the Scandit logo. To shift the logo relative to the anchor, use logoOffset.

Default is Anchor.bottomRight.

logoOffset

PointWithUnit logoOffset

Added in version 8.6.0

The offset applied to the Scandit logo relative to the logo anchor. When specified in pixels (MeasureUnit.pixel) the offset is used as-is. When specified as a fraction (MeasureUnit.fraction) the offset is computed relative to the view size minus the scan area margins.

Default is a zero offset.

shouldShowMacroModeControl

bool shouldShowMacroModeControl

Added in version 7.1.0

Indicates whether the macro mode control button should be shown to the user.

Note

This property is only supported on iOS devices.

macroModeControlPosition

Anchor macroModeControlPosition

Added in version 7.1.0

Updates the position of the macro mode control button.

Default is Anchor.topRight.

Note

This property is only supported on iOS devices.

macroModeControlOffset

PointWithUnit? macroModeControlOffset

Added in version 8.6.0

Sets the visual offset of the macro mode control button.

start()

Future<void> start()

Added in version 7.1.0

Starts the scanning process.

stop()

Future<void> stop()

Added in version 7.1.0

Stops the scanning process.

pause()

Future<void> pause()

Added in version 7.1.0

Pauses the scanning process.

reset()

Future<void> reset()

Added in version 7.2.0

Clears all highlights and annotations currently visible and calls highlightProvider and annotationProvider to supply new highlights and annotations.

createState()

State<StatefulWidget> createState()

Added in version 7.1.0

Implemented from StatefulWidget. Called by the Flutter framework.