Class MrzScannerConfiguration

Namespace

ScanbotSDK.MAUI.MRZ

Assembly

DocumentSDK.MAUI.dll

public sealed class MrzScannerConfiguration

Inheritance

object

MrzScannerConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

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

CameraPreviewMode

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

public CameraPreviewMode? CameraPreviewMode { get; set; }

Property Value

CameraPreviewMode?

CancelButtonHidden

Whether the cancel button is hidden or not.

public bool? CancelButtonHidden { get; set; }

Property Value

bool?

CancelButtonTitle

String being displayed on the cancel button.

public string CancelButtonTitle { get; set; }

Property Value

string

EnableCameraButtonTitle

String being displayed on the button to request camera access.

public string EnableCameraButtonTitle { get; set; }

Property Value

string

EnableCameraExplanationText

String being displayed on the label describing the camera access requirement.

public string EnableCameraExplanationText { get; set; }

Property Value

string

FinderAspectRatio

Aspect ratio of the finder window.

public AspectRatio FinderAspectRatio { get; set; }

Property Value

AspectRatio

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 int? FinderLineWidth { get; set; }

Property Value

int?

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

FlashButtonInactiveColor

Foreground color of the flash button when flash is off.

public Color FlashButtonInactiveColor { get; set; }

Property Value

Color

FlashEnabled

Controls whether the flash should be initially enabled. The default value is FALSE.

public bool? FlashEnabled { get; set; }

Property Value

bool?

OrientationLockMode

Allowed orientations for automatic interface rotations. *

public OrientationLockMode? OrientationLockMode { get; set; }

Property Value

OrientationLockMode?

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

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, as defined by the Android Material Design. Defaults to TRUE. Android only.

public bool? UseButtonsAllCaps { get; set; }

Property Value

bool?