Class CameraConfiguration

Namespace

ScanbotSDK.MAUI.Common

Assembly

ScanbotSDK.Shared.dll

Configuration of the camera settings to be used while scanning.

public class CameraConfiguration

Inheritance

object

CameraConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

CameraLiveScannerResolution

The size of the image from camera which would be sent to the scanner for live scanning.

Default is FULL_HD

public CameraLiveScannerResolution CameraLiveScannerResolution { get; set; }

Property Value

CameraLiveScannerResolution

CameraModule

Determines which camera module to use on start-up.

Default is BACK

public CameraModule CameraModule { get; set; }

Property Value

CameraModule

CameraPreviewAspectRatio

Tries to select the camera preview aspect ratio that best matches the given aspect ratio. If no exact match is found, it selects the closest one available. Android only.

public CameraPreviewAspectRatio? CameraPreviewAspectRatio { get; set; }

Property Value

CameraPreviewAspectRatio?

CameraPreviewMode

Determines which camera preview mode to use.

Default is FILL_IN

public CameraPreviewMode CameraPreviewMode { get; set; }

Property Value

CameraPreviewMode

DefaultZoomFactor

The default zoom factor on start-up.

Default is 1.0

public double DefaultZoomFactor { get; set; }

Property Value

double

FlashEnabled

Determines whether the flash is enabled on start-up.

Default is false

public bool FlashEnabled { get; set; }

Property Value

bool

FpsLimit

The rate of detections/recognitions per second in normal performance mode. If the number is equal or greater than the video frame rate, no frames will be skipped.

Default is 20

public int FpsLimit { get; set; }

Property Value

int

HardwareButtonsEnabled

When enabled it allows zooming using camera control button (iPhone 16 series). iOS only.

Default is true

public bool HardwareButtonsEnabled { get; set; }

Property Value

bool

MinFocusDistanceLock

Determines whether to lock the focus at the minimum possible distance (device-specific).

Default is false

public bool MinFocusDistanceLock { get; set; }

Property Value

bool

OrientationLockMode

Determines which mode to use when orientation should be locked to landscape or portrait.

Default is NONE

public OrientationLockMode OrientationLockMode { get; set; }

Property Value

OrientationLockMode

PinchToZoomEnabled

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

Default is true

public bool PinchToZoomEnabled { get; set; }

Property Value

bool

TouchToFocusEnabled

Determines whether touch-to-focus is enabled or not.

Default is false

public bool TouchToFocusEnabled { get; set; }

Property Value

bool

ZoomSteps

The zoom steps available to the user.

public double[] ZoomSteps { get; set; }

Property Value

double[]

Methods

FromJson(string)

public static CameraConfiguration FromJson(string rawJson)

Parameters

rawJson string

Returns

CameraConfiguration