Interface ICommonBarcodeScannerConfiguration
- Namespace
- ScanbotSDK.MAUI.RTU.v1
- Assembly
- ScanbotSDK.Shared.dll
public interface ICommonBarcodeScannerConfiguration
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)
List<BarcodeDocumentFormat> AcceptedDocumentFormats { get; set; }
Property Value
AutoCancelTimeout
Time in seconds until the screen is automatically cancelled. By default, this is disabled.
TimeSpan? AutoCancelTimeout { get; set; }
Property Value
BarcodeFormats
List of accepted barcode formats.
List<BarcodeFormat> BarcodeFormats { get; set; }
Property Value
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.
CameraModule? CameraModule { get; set; }
Property Value
CameraOverlayColor
Background color of the detection overlay.
Color CameraOverlayColor { get; set; }
Property Value
CameraPreviewMode
Preview mode of the camera: fit-in or fill-in. Optional, default is [CameraPreviewMode.FillIn]
CameraPreviewMode? CameraPreviewMode { get; set; }
Property Value
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.
float? CameraZoomLevel { get; set; }
Property Value
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.
ZoomRange CameraZoomRange { get; set; }
Property Value
CancelButtonTitle
String being displayed on the cancel button.
string CancelButtonTitle { get; set; }
Property Value
DelayAfterScan
Sets delay after scan in ms. 0 = disabled and it is the default value
long? DelayAfterScan { get; set; }
Property Value
- long?
EnableCameraButtonTitle
If set to true, it makes the camera button title visible.
string EnableCameraButtonTitle { get; set; }
Property Value
EnableCameraExplanationText
The camera explanation text.
string EnableCameraExplanationText { get; set; }
Property Value
EngineMode
The desired engine mode. You can set it to "Legacy" to use the outdated detection engine. Default is NextGen.
EngineMode EngineMode { get; set; }
Property Value
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.
AspectRatio FinderAspectRatio { get; set; }
Property Value
FinderEnabled
Set to 'true' to enable and display the region of interest, to 'false' otherwise. The default value is 'true'.
bool? FinderEnabled { get; set; }
Property Value
- bool?
FinderLineColor
Foreground color of the detection overlay.
Color? FinderLineColor { get; set; }
Property Value
FinderLineWidth
Width of finder frame border. Default is 2.
double? FinderLineWidth { get; set; }
Property Value
FinderTextHint
String being displayed as description.
string FinderTextHint { get; set; }
Property Value
FinderTextHintColor
Foreground color of the description label.
Color? FinderTextHintColor { get; set; }
Property Value
FlashEnabled
Whether flash is toggled on or off.
bool? FlashEnabled { get; set; }
Property Value
- bool?
InitialScanDelay
The initial recognition delay in seconds. Defaults to 0.0.
TimeSpan? InitialScanDelay { get; set; }
Property Value
MinFocusDistanceLock
Whether or not the focus should be locked to the minimum value supported by the device. Commonly used for tiny barcode scanning.
bool? MinFocusDistanceLock { get; set; }
Property Value
- bool?
OrientationLockMode
Desired interface orientation (Portrait, Landscape or All). Default is 'All'.
OrientationLockMode? OrientationLockMode { get; set; }
Property Value
OverlayConfiguration
Overlay configuration. If enabled, PolygonColor, TextColor and TextContainerColor are required, rest are optional
SelectionOverlayConfiguration? OverlayConfiguration { get; set; }
Property Value
SuccessBeepEnabled
Whether scanner screen should make a sound on successful barcode or MRZ detection.
bool? SuccessBeepEnabled { get; set; }
Property Value
- bool?
TopBarBackgroundColor
Background color of the top bar.
Color? TopBarBackgroundColor { get; set; }
Property Value
TopBarButtonsColor
Foreground color of the cancel button and when flash button is on.
Color? TopBarButtonsColor { get; set; }
Property Value
TopBarButtonsInactiveColor
Foreground color of the flash button when flash is off.
Color? TopBarButtonsInactiveColor { get; set; }
Property Value
TouchToFocusEnabled
Controls whether the touch to focus feature should be enabled. Default is true
.
bool? TouchToFocusEnabled { get; set; }
Property Value
- bool?
UseButtonsAllCaps
Controls whether buttons should use all capitals style.
bool? UseButtonsAllCaps { get; set; }
Property Value
- bool?