Table of Contents

Class BatchBarcodeScannerConfiguration

Namespace
ScanbotSDK.MAUI.RTU.v1
Assembly
ScanbotSDK.Shared.dll
public sealed class BatchBarcodeScannerConfiguration : BarcodeScannerAdditionalParameters, ICommonBarcodeScannerConfiguration
Inheritance
BatchBarcodeScannerConfiguration
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

Sets auto close timer in seconds. 0 = disabled and it is the default value.

public TimeSpan? AutoCancelTimeout { get; set; }

Property Value

TimeSpan?

BarcodeFormats

List of accepted barcode formats.

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

Property Value

List<BarcodeFormat>

BarcodesCountText

String used for displaying amount of scanned barcodes. Use %d for number formatting symbol.

public string BarcodesCountText { get; set; }

Property Value

string

BarcodesCountTextColor

Text color of the barcodes count label.

public Color BarcodesCountTextColor { get; set; }

Property Value

Color

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

CameraPreviewMode

Preview mode of the camera: fit-in or fill-in. Optional, default is [CameraPreviewMode.FillIn]

public CameraPreviewMode? CameraPreviewMode { get; set; }

Property Value

CameraPreviewMode?

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

ClearButtonTitle

String being displayed on the clear button.

public string ClearButtonTitle { get; set; }

Property Value

string

DelayAfterScan

Sets delay after scan in ms. 0 = disabled and it is the default value

public long? DelayAfterScan { get; set; }

Property Value

long?

DetailsActionColor

Foreground color of the top bar buttons on the details screen.

public Color DetailsActionColor { get; set; }

Property Value

Color

DetailsBackgroundColor

Background color of the details screen.

public Color DetailsBackgroundColor { get; set; }

Property Value

Color

DetailsPrimaryColor

Text color in the details barcodes list. Also affects image background, separator and progress spinner.

public Color DetailsPrimaryColor { get; set; }

Property Value

Color

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?

FetchingStateText

String used to show process of fetching mapped data for barcodes.

public string FetchingStateText { get; set; }

Property Value

string

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?

MinFocusDistanceLock

Whether or not the focus should be locked to the minimum value supported by the device. Commonly used for tiny barcode scanning.

public bool? MinFocusDistanceLock { get; set; }

Property Value

bool?

NoBarcodesTitle

String to show that no barcodes were scanned yet.

public string NoBarcodesTitle { get; set; }

Property Value

string

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

SubmitButtonTitle

String being displayed on the submit button.

public string SubmitButtonTitle { get; set; }

Property Value

string

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 top bar buttons on the scanning screen.

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

TouchToFocusEnabled

Controls whether the touch to focus feature should be enabled. Default is true.

public bool? TouchToFocusEnabled { get; set; }

Property Value

bool?

UseButtonsAllCaps

Controls whether buttons should use all capitals style.

public bool? UseButtonsAllCaps { get; set; }

Property Value

bool?