Table of Contents

Class DocumentScannerCameraConfiguration

Namespace
ScanbotSDK.MAUI.Document
Assembly
ScanbotSDK.Shared.dll

Configuration of the camera behavior.

public class DocumentScannerCameraConfiguration
Inheritance
DocumentScannerCameraConfiguration
Inherited Members

Properties

AcceptedAngleScore

The minimum pitch/skew angle of the document to be accepted. The value must be between 0.0 and 1.0. Default is 0.75

public double AcceptedAngleScore { get; set; }

Property Value

double

AcceptedBrightnessThreshold

The minimum brightness value to accept a detected document. Default is 50

public int AcceptedBrightnessThreshold { get; set; }

Property Value

int

AcceptedSizeScore

The minimum size of the document in relation to the screen preview to be accepted. The value must be between 0.0 and 1.0. Default is 0.75

public double AcceptedSizeScore { get; set; }

Property Value

double

AutoSnappingDelay

After a page has been snapped, the delay in milliseconds before auto snapping resumes for the next page. Default is 200

public int AutoSnappingDelay { get; set; }

Property Value

int

AutoSnappingEnabled

Determines if auto snapping is enabled or not. Default is true

public bool AutoSnappingEnabled { get; set; }

Property Value

bool

AutoSnappingSensitivity

Controls the auto snapping speed. The sensitivity must be between 0.0 and 1.0. A value of 1.0 triggers auto snapping immediately, while a value of 0.0 delays the auto snapping by 3 seconds. The default value is 0.66 (1 second). Default is 0.66

public double AutoSnappingSensitivity { get; set; }

Property Value

double

CameraModule

Determines which camera module to use on start-up. Default is BACK

public CameraModule CameraModule { get; set; }

Property Value

CameraModule

CameraPreviewMode

Determines which camera preview mode to use. Default is FILL_IN

public CameraPreviewMode CameraPreviewMode { get; set; }

Property Value

CameraPreviewMode

CaptureQualityPrioritization

Determines the prioritization of still image quality and capturing speed. Default is BALANCED

public CapturePhotoQualityPrioritization CaptureQualityPrioritization { get; set; }

Property Value

CapturePhotoQualityPrioritization

CaptureWithHardwareButtonsEnabled

When enabled the hardware volume up/down buttons can be used to capture an image if manual snapping is enabled. For iOS version 17.2 or later is required. On iPhones with camera control (iPhone 16 series) this also enables zooming and capturing with the camera control. Default is true

public bool CaptureWithHardwareButtonsEnabled { get; set; }

Property Value

bool

DefaultZoomFactor

The default zoom factor on start-up. Default is 1.0

public double DefaultZoomFactor { get; set; }

Property Value

double

FlashEnabled

Determines whether the flashlight is enabled or not on start-up. Default is false

public bool FlashEnabled { get; set; }

Property Value

bool

IgnoreBadAspectRatio

Determines whether a landscape document will be detected when the camera is in portrait mode (and vice versa) or not. This parameter will be ignored if required aspect ratios have been explicitly defined. Default is true

public bool IgnoreBadAspectRatio { get; set; }

Property Value

bool

MinFocusDistanceLock

Determines whether locking the focus at the minimum possible distance is enabled or not (device-specific). Default is false

public bool MinFocusDistanceLock { get; set; }

Property Value

bool

PinchToZoomEnabled

Determines whether pinch-to-zoom is enabled or not. Default is true

public bool PinchToZoomEnabled { get; set; }

Property Value

bool

RequiredAspectRatios

The required aspect ratios for the document to be accepted.

public AspectRatio[] RequiredAspectRatios { get; set; }

Property Value

AspectRatio[]

Methods

FromJson(string) 

public static DocumentScannerCameraConfiguration FromJson(string rawJson)

Parameters

rawJson string

Returns

DocumentScannerCameraConfiguration