Table of Contents

Class BarcodeScannerConfiguration

Namespace
ScanbotSDK.MAUI.Barcode.RTU.v1
Assembly
ScanbotSDK.Shared.dll
public sealed class BarcodeScannerConfiguration : BarcodeScannerAdditionalParameters, ICommonBarcodeScannerConfiguration
Inheritance
BarcodeScannerConfiguration
Implements
Inherited Members

Properties

AcceptedDocumentFormats

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> AcceptedDocumentFormats { get; set; }

Property Value

List<BarcodeDocumentFormat>

AutoCancelTimeout

Time in seconds until the screen is automatically cancelled. By default, this is disabled.

public TimeSpan? AutoCancelTimeout { get; set; }

Property Value

TimeSpan?

BarcodeFormats

List of accepted barcode formats.

public List<BarcodeFormat> BarcodeFormats { get; set; }

Property Value

List<BarcodeFormat>

BarcodeImageGenerationType

Specifies the way of barcode images generation or disables this generation at all. Use, if you want to receive a full sized image with barcodes. Defaults to SBSDKBarcodeImageGenerationTypeNone.

public BarcodeImageGenerationType BarcodeImageGenerationType { get; set; }

Property Value

BarcodeImageGenerationType

CameraModule

Set supported camera module. Optional.By default is [CameraModule.Back] The enum type [CameraModule.BackWidest] is iOS only, It will be considered [CameraModule.Back] for Android.

public CameraModule? CameraModule { get; set; }

Property Value

CameraModule?

CameraOverlayColor

Background color of the detection overlay.

public Color CameraOverlayColor { get; set; }

Property Value

Color

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

CancelButtonTitle

String being displayed on the cancel button.

public string CancelButtonTitle { get; set; }

Property Value

string

ConfirmationDialogConfiguration

The configuration for a confirmation dialog after a barcode has been scanned. If null, no confirmation dialog will be present.

public BarcodeConfirmationDialogConfiguration ConfirmationDialogConfiguration { get; set; }

Property Value

BarcodeConfirmationDialogConfiguration

EnableCameraButtonTitle

If set to true, it makes the camera button title visible.

public string EnableCameraButtonTitle { get; set; }

Property Value

string

EnableCameraExplanationText

The camera explanation text.

public string EnableCameraExplanationText { get; set; }

Property Value

string

EngineMode

The desired engine mode. You can set it to "Legacy" to use the outdated detection engine. Default is NextGen.

public EngineMode EngineMode { get; set; }

Property Value

EngineMode

ExtensionFilter

Filter for extended EAN and UPC barcodes (iOS only).

public BarcodesExtensionFilter? ExtensionFilter { get; set; }

Property Value

BarcodesExtensionFilter?

FinderAspectRatio

Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 1 - it is a square frame, which is good for QR capturing.

public AspectRatio? FinderAspectRatio { get; set; }

Property Value

AspectRatio

FinderEnabled

Whether or not the finder should be enabled. By default, this is enabled.

public bool? FinderEnabled { get; set; }

Property Value

bool?

FinderLineColor

Foreground color of the detection overlay.

public Color FinderLineColor { get; set; }

Property Value

Color

FinderLineWidth

Width of finder frame border. Default is 2.

public double? FinderLineWidth { get; set; }

Property Value

double?

FinderTextHint

String being displayed as description.

public string FinderTextHint { get; set; }

Property Value

string

FinderTextHintColor

Foreground color of the description label.

public Color FinderTextHintColor { get; set; }

Property Value

Color

FlashEnabled

Whether flash is toggled on or off.

public bool? FlashEnabled { get; set; }

Property Value

bool?

InitialScanDelay

The initial delay before scanning a barcode. By default, this is disabled.

public TimeSpan? InitialScanDelay { get; set; }

Property Value

TimeSpan?

OrientationLockMode

Desired interface orientation (Portrait, Landscape or All). Default is 'All'.

public OrientationLockMode? OrientationLockMode { get; set; }

Property Value

OrientationLockMode?

OverlayConfiguration

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

public SelectionOverlayConfiguration OverlayConfiguration { get; set; }

Property Value

SelectionOverlayConfiguration

SuccessBeepEnabled

Whether scanner screen should make a sound on successful barcode or MRZ detection.

public bool? SuccessBeepEnabled { get; set; }

Property Value

bool?

TopBarBackgroundColor

Background color of the top bar.

public Color TopBarBackgroundColor { get; set; }

Property Value

Color

TopBarButtonsColor

Foreground color of the cancel button and when flash button is on.

public Color TopBarButtonsColor { get; set; }

Property Value

Color

TopBarButtonsInactiveColor

Foreground color of the flash button when flash is off.

public Color TopBarButtonsInactiveColor { get; set; }

Property Value

Color