Class CheckRecognizerConfiguration

Namespace

ScanbotSDK.MAUI.Check

Assembly

DocumentSDK.MAUI.dll

public sealed class CheckRecognizerConfiguration

Inheritance

object

CheckRecognizerConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AcceptedCheckStandards

Accepted check standards. Optional, by default - all checks are accepted. With an empty list no filter is applied and all checks are accepted.

public List<CheckStandard> AcceptedCheckStandards { get; set; }

Property Value

List<CheckStandard>

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 outside of the finder window.

public Color CameraOverlayColor { get; set; }

Property Value

Color

CameraPreviewMode

Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only

public CameraPreviewMode? CameraPreviewMode { get; set; }

Property Value

CameraPreviewMode?

CancelButtonTitle

Title of the cancel button.

public string CancelButtonTitle { get; set; }

Property Value

string

CaptureHighResolutionImage

Set high-resolution Check image capturing. If set to TRUE a high-resolution photo of the check is captured to run the recognition on. Upon successful recognition the recognition result also contains a high-resolution image of the check. If set to FALSE, the video frames will be used for recognition and result image delivery. The default value is TRUE.

public bool? CaptureHighResolutionImage { get; set; }

Property Value

bool?

EnableCameraButtonTitle

Title of the button that opens the screen where the user can allow the usage of the camera by the app.

public string EnableCameraButtonTitle { get; set; }

Property Value

string

EnableCameraExplanationText

Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.

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

Property Value

double?

FlashButtonTitle

Title of the flash toggle button.

public string FlashButtonTitle { get; set; }

Property Value

string

FlashEnabled

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

public bool? FlashEnabled { get; set; }

Property Value

bool?

OrientationLockMode

UI Interface orientation lock mode

public OrientationLockMode? OrientationLockMode { get; set; }

Property Value

OrientationLockMode?

TopBarBackgroundColor

The background color of the top toolbar.

public Color TopBarBackgroundColor { get; set; }

Property Value

Color

TopBarButtonsActiveColor

The color of all active toggle buttons in the toolbar.

public Color TopBarButtonsActiveColor { get; set; }

Property Value

Color

TopBarButtonsInactiveColor

The color of all inactive toggle buttons in the toolbar.

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

public bool? UseButtonsAllCaps { get; set; }

Property Value

bool?

UserGuidanceBackgroundColor

The background color of the user guidance hints.

public Color UserGuidanceBackgroundColor { get; set; }

Property Value

Color

UserGuidanceStringValues

Configuration that helps to override default hint values.

public CheckUserGuidanceStrings UserGuidanceStringValues { get; set; }

Property Value

CheckUserGuidanceStrings

UserGuidanceTextColor

The text color of the user guidance hints.

public Color UserGuidanceTextColor { get; set; }

Property Value

Color