Class VINScannerConfiguration

Namespace

ScanbotSDK.MAUI.VIN

Assembly

DocumentSDK.MAUI.dll

A class describing the required for ready-to-use vehicle identification number scanner.

public sealed class VINScannerConfiguration

Inheritance

object

VINScannerConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

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: fit-in or fill-in. Optional, default is [CameraPreviewMode.FillIn]

public CameraPreviewMode? CameraPreviewMode { get; set; }

Property Value

CameraPreviewMode?

CancelButtonTitle

Title of the cancel button.

public string CancelButtonTitle { get; set; }

Property Value

string

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

Color of the finder window's outline

public Color FinderLineColor { get; set; }

Property Value

Color

FinderLineWidth

Thickness of the finder window's outline.

public double? FinderLineWidth { get; set; }

Property Value

double?

FinderTextHintColor

The color of the text with user guidance below the finder view.

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

GuidanceText

User guidance hint text.

public string GuidanceText { get; set; }

Property Value

string

MaximumNumberOfAccumulatedFrames

The maximum number of accumulated video frames before the current recognition result is returned. Default is 3.

public int? MaximumNumberOfAccumulatedFrames { get; set; }

Property Value

int?

MinimumNumberOfRequiredFramesWithEqualRecognitionResult

The minimum equal results in accumulated video frames to count as valid. Default is 2.

public int? MinimumNumberOfRequiredFramesWithEqualRecognitionResult { get; set; }

Property Value

int?

OcrResolutionLimit

The image will be downscaled to the given value during the processing. If the quality of the scanning is not enough, try to increase the limit. This variable affects the performance of the scanning process. Higher the size limit - better the quality, but the recognition is slower 0 - do not rescale.

public int? OcrResolutionLimit { get; set; }

Property Value

int?

OrientationLockMode

Orientation lock mode of the camera: Portrait or Landscape. By default the camera orientation is not locked.

public OrientationLockMode? OrientationLockMode { get; set; }

Property Value

OrientationLockMode?

SignificantShakeDelay

Detection will be paused after significant movement, in milliseconds. Default is 1000.

public long? SignificantShakeDelay { get; set; }

Property Value

long?

TopBarBackgroundColor

Background color of the top toolbar.

public Color TopBarBackgroundColor { get; set; }

Property Value

Color

TopBarButtonsColor

Color of the titles of all buttons in the top toolbar.

public Color TopBarButtonsColor { get; set; }

Property Value

Color

TopBarButtonsInactiveColor

Color of the titles of all buttons in the top 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.

public bool? UseButtonsAllCaps { get; set; }

Property Value

bool?