Table of Contents

Class BaseBarcodeScannerView

Namespace
ScanbotSDK.MAUI.Barcode.ClassicComponent
Assembly
ScanbotSDK.Shared.dll
public abstract class BaseBarcodeScannerView : View, INotifyPropertyChanged, IVisualTreeElement, IEffectControlProvider, IToolTipElement, IContextFlyoutElement, IAnimatable, IViewController, IVisualElementController, IElementController, IGestureController, IGestureRecognizers, IPropertyMapperView, IHotReloadableView, IReplaceableView, IView, ITransform, IElement
Inheritance
BaseBarcodeScannerView
Implements
Derived
Inherited Members

Fields

AccumulationConfigurationProperty 

public static readonly BindableProperty AccumulationConfigurationProperty

Field Value

BindableProperty

BarcodeFormatConfigurationsProperty 

public static readonly BindableProperty BarcodeFormatConfigurationsProperty

Field Value

BindableProperty

CameraModuleProperty

Represents all supported cameras.

public static readonly BindableProperty CameraModuleProperty

Field Value

BindableProperty

CameraZoomLevelProperty 

public static readonly BindableProperty CameraZoomLevelProperty

Field Value

BindableProperty

CameraZoomRangeProperty 

public static readonly BindableProperty CameraZoomRangeProperty

Field Value

BindableProperty

EngineModeProperty 

public static readonly BindableProperty EngineModeProperty

Field Value

BindableProperty

ExtractedDocumentFormatsProperty 

public static readonly BindableProperty ExtractedDocumentFormatsProperty

Field Value

BindableProperty

FinderConfigurationProperty 

public static readonly BindableProperty FinderConfigurationProperty

Field Value

BindableProperty

FpsLimitProperty 

public static readonly BindableProperty FpsLimitProperty

Field Value

BindableProperty

IsFlashEnabledProperty 

public static readonly BindableProperty IsFlashEnabledProperty

Field Value

BindableProperty

KeepScreenOnProperty 

public static readonly BindableProperty KeepScreenOnProperty

Field Value

BindableProperty

MinFocusDistanceLockProperty 

public static readonly BindableProperty MinFocusDistanceLockProperty

Field Value

BindableProperty

OnlyAcceptDocumentsProperty 

public static readonly BindableProperty OnlyAcceptDocumentsProperty

Field Value

BindableProperty

OptimizeForOverlaysProperty 

public static readonly BindableProperty OptimizeForOverlaysProperty

Field Value

BindableProperty

OverlayConfigurationProperty 

public static readonly BindableProperty OverlayConfigurationProperty

Field Value

BindableProperty

Properties

AccumulationConfiguration 

public BarcodeAccumulationConfiguration AccumulationConfiguration { get; set; }

Property Value

BarcodeAccumulationConfiguration

BarcodeFormatConfigurations

List of accepted barcode formats.

public List<BarcodeFormatConfigurationBase> BarcodeFormatConfigurations { get; set; }

Property Value

List<BarcodeFormatConfigurationBase>

CameraModule 

public CameraModule CameraModule { get; set; }

Property Value

CameraModule

CameraZoomLevel

The relative zoom level of the camera relative to CameraZoomRange. The minimum value is 0.0 (zoomed out), the maximum value is 1.0 (zoomed in). The default value is 0.0, zoomed out.

public float? CameraZoomLevel { get; set; }

Property Value

float?

CameraZoomRange

The range of valid camera zoom factors. Default value is (1.0; 12.0). Use [ZoomRange.Default] property to use the default zoom range.

public ZoomRange CameraZoomRange { get; set; }

Property Value

ZoomRange

EngineMode

The engine mode for barcode scanning. Default is BarcodeScannerEngineMode.NextGen.

public BarcodeScannerEngineMode EngineMode { get; set; }

Property Value

BarcodeScannerEngineMode

ExtractedDocumentFormats

An optional array of Document Formats that act as a detection filter. Only the specified Document Formats will be recognized! Default is empty (all supported Document Formats will be recognized)

public List<BarcodeDocumentFormat> ExtractedDocumentFormats { get; set; }

Property Value

List<BarcodeDocumentFormat>

FinderConfiguration 

public FinderConfiguration FinderConfiguration { get; set; }

Property Value

FinderConfiguration

FpsLimit

The rate of detections/recognitions per second in normal performance mode. If the number is equal or greater than the video frame rate, no frames will be skipped. By default, the frame rate is set to the maximum possible value.

public float? FpsLimit { get; set; }

Property Value

float?

IsFlashEnabled 

public bool IsFlashEnabled { get; set; }

Property Value

bool

KeepScreenOn 

public bool? KeepScreenOn { get; set; }

Property Value

bool?

MinFocusDistanceLock

Whether to lock the focus on the minimum possible distance (device-specific). Default is false. Works on iOS only if you have a single camera.

public bool MinFocusDistanceLock { get; set; }

Property Value

bool

OnlyAcceptDocuments

If true and ExtractedDocumentFormats is not empty, then barcodes that don't decode to one of the extracted document formats will be ignored. Default is false.

public bool OnlyAcceptDocuments { get; set; }

Property Value

bool

OptimizeForOverlays 

public bool OptimizeForOverlays { get; set; }

Property Value

bool

OverlayConfiguration

Overlay configuration. If enabled, PolygonColor, TextColor and TextContainerColor are required, rest are optional

public SelectionOverlayConfiguration OverlayConfiguration { get; set; }

Property Value

SelectionOverlayConfiguration

Methods

FreezeCamera() 

public void FreezeCamera()

RaiseScanningFailed(Exception) 

protected void RaiseScanningFailed(Exception ex)

Parameters

ex Exception

UnFreezeCamera() 

public void UnFreezeCamera()

Events

OnBarcodeScanningError 

public event EventHandler<Exception> OnBarcodeScanningError

Event Type

EventHandler<Exception>