Class ScannerConfigurationBase

Namespace

ScanbotSDK.MAUI

Assembly

DocumentSDK.MAUI.dll

public class ScannerConfigurationBase

Inheritance

object

ScannerConfigurationBase

Derived

DocumentScannerConfiguration

FinderDocumentScannerConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AcceptedAngleScore

The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document. Default is 75.0. Set lower values to accept more perspective distortion. Warning: Lower values result in more blurred document images.

public double? AcceptedAngleScore { get; set; }

Property Value

double?

AcceptedBrightnessThreshold

The brightness threshold to accept a detected document in the range of 0 (very dark) to 255 (very bright). If the average brightness value of the detectors input image is below this value, the status of the detection will be set to [SBSDKDocumentDetectionStatus.ErrorBrightness]

Minimum value: 0, maximum value: 255. Defaults to 50.

public int? AcceptedBrightnessThreshold { get; set; }

Property Value

int?

AcceptedSizeScore

The minimum size in percent (0 - 100) of the screen size to accept a detected document. It is sufficient that height or width match the score. Default is 80.0. Warning: Lower values result in low resolution document images.

public double? AcceptedSizeScore { get; set; }

Property Value

double?

AutoSnappingEnabled

Whether auto-snapping is enabled or not.

public bool? AutoSnappingEnabled { get; set; }

Property Value

bool?

AutoSnappingSensitivity

The sensivity of auto-snapping. Values are clamped to the range 0.0 - 1.0. A value of 1.0 triggers automatic snapping immediately, a value of 0.0 delays the automatic by 3 seconds.

public double? AutoSnappingSensitivity { get; set; }

Property Value

double?

CameraBackgroundColor

Background color of the camera view. *

public Color CameraBackgroundColor { 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?

CameraPreviewMode

The video layers content mode.

public CameraPreviewMode? CameraPreviewMode { get; set; }

Property Value

CameraPreviewMode?

CancelButtonTitle

public string CancelButtonTitle { get; set; }

Property Value

string

DefaultPageFilter

The default image filter type for new documents pages. Defaults to SBSDKImageFilterTypeNone. // setImageFilterType

public ImageFilter? DefaultPageFilter { get; set; }

Property Value

ImageFilter?

DocumentImageSizeLimit

public Size? DocumentImageSizeLimit { get; set; }

Property Value

Size?

EnableCameraButtonTitle

public string EnableCameraButtonTitle { get; set; }

Property Value

string

EnableCameraExplanationText

public string EnableCameraExplanationText { get; set; }

Property Value

string

FlashButtonHidden

public bool? FlashButtonHidden { get; set; }

Property Value

bool?

FlashEnabled

public bool? FlashEnabled { get; set; }

Property Value

bool?

ForceUserGuidance

public bool? ForceUserGuidance { get; set; }

Property Value

bool?

IgnoreBadAspectRatio

public bool? IgnoreBadAspectRatio { get; set; }

Property Value

bool?

ImageScale

public double? ImageScale { get; set; }

Property Value

double?

OrientationLockMode

Allowed orientations for automatic interface rotations. *

public OrientationLockMode? OrientationLockMode { get; set; }

Property Value

OrientationLockMode?

PhotoQualityPrioritization

The prioritization of still image quality and capturing speed. Defaults to CapturePhotoQualityPrioritization.BALANCED. If you experience lots of blurry still images try to set this property to CapturePhotoQualityPrioritization.QUALITY. Note: Has no effect on devices prior to iOS 13.0!. iOS only.

public CapturePhotoQualityPrioritization? PhotoQualityPrioritization { get; set; }

Property Value

CapturePhotoQualityPrioritization?

PolygonBackgroundColor

public Color PolygonBackgroundColor { get; set; }

Property Value

Color

PolygonBackgroundColorOK

public Color PolygonBackgroundColorOK { get; set; }

Property Value

Color

PolygonColor

public Color PolygonColor { get; set; }

Property Value

Color

PolygonColorOK

public Color PolygonColorOK { get; set; }

Property Value

Color

PolygonCornerRadius

The radius to use when drawing rounded corners of the detected documents polygon. Default is 8.0.

public int? PolygonCornerRadius { get; set; }

Property Value

int?

PolygonLineWidth

public int? PolygonLineWidth { get; set; }

Property Value

int?

ShutterButtonAutoInnerColor

public Color ShutterButtonAutoInnerColor { get; set; }

Property Value

Color

ShutterButtonAutoOuterColor

public Color ShutterButtonAutoOuterColor { get; set; }

Property Value

Color

ShutterButtonHidden

public bool? ShutterButtonHidden { get; set; }

Property Value

bool?

ShutterButtonManualInnerColor

public Color ShutterButtonManualInnerColor { get; set; }

Property Value

Color

ShutterButtonManualOuterColor

public Color ShutterButtonManualOuterColor { get; set; }

Property Value

Color

ShutterSoundEnabled

public bool? ShutterSoundEnabled { get; set; }

Property Value

bool?

TextHintBadAngles

public string TextHintBadAngles { get; set; }

Property Value

string

TextHintBadAspectRatio

public string TextHintBadAspectRatio { get; set; }

Property Value

string

TextHintNothingDetected

The text being displayed on the user-guidance label, when no document was detected.

public string TextHintNothingDetected { get; set; }

Property Value

string

TextHintOK

The text being displayed on the user-guidance label, when a document was detected with good conditions.

public string TextHintOK { get; set; }

Property Value

string

TextHintTooDark

The text being displayed on the user-guidance label, when no document was detected becasue the image is too dark.

public string TextHintTooDark { get; set; }

Property Value

string

TextHintTooNoisy

The text being displayed on the user-guidance label, when no document was detected because of image noise.

public string TextHintTooNoisy { get; set; }

Property Value

string

TextHintTooSmall

The text being displayed on the user-guidance label, when a document was detected, but the documents area is too small compared to the image area.

public string TextHintTooSmall { get; set; }

Property Value

string

TopBarBackgroundColor

Background color of the top bar.

public Color TopBarBackgroundColor { get; set; }

Property Value

Color

TopBarButtonsActiveColor

Foreground color of enabled items in the top bar.

public Color TopBarButtonsActiveColor { get; set; }

Property Value

Color

TopBarButtonsInactiveColor

Foreground color of disabled items in the top bar.

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?

UserGuidanceBackgroundColor

Background color of the user guidance label.

public Color UserGuidanceBackgroundColor { get; set; }

Property Value

Color

UserGuidanceTextColor

Foreground/text color of the user guidance label.

public Color UserGuidanceTextColor { get; set; }

Property Value

Color