Class SdkConfiguration

Namespace

ScanbotSDK.MAUI.Core.Sdk

Assembly

ScanbotSDK.Shared.dll

Initialize configuration for the Scanbot SDK.

public class SdkConfiguration

Inheritance

object

SdkConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AllowGpuAcceleration

If set to true, GPU Acceleration will be enabled for Barcode Scanner, Document Scanner and Generic Document Recognizer (Android only).

Default is true

public bool AllowGpuAcceleration { get; set; }

Property Value

bool

AllowXnnpackAcceleration

Enables/disables XNNPACK acceleration for TensorFlow ML models, which provides highly optimized implementations of floating-point neural network operators (Android only).

Default is true

public bool AllowXnnpackAcceleration { get; set; }

Property Value

bool

EnableNativeLogging

Optional boolean flag that enables Scanbot SDK Core native logging (default is false, Android only).

Default is false

public bool EnableNativeLogging { get; set; }

Property Value

bool

ErrorHandler

Optional: License error handler, will be called when trying to access a feature that's not available in your license

public Action<LicenseStatus, Feature, string> ErrorHandler { get; set; }

Property Value

Action<LicenseStatus, Feature, string>

FileEncryptionMode

Optional file encryption mode, 'AES128' or 'AES256'.

public FileEncryptionMode? FileEncryptionMode { get; set; }

Property Value

FileEncryptionMode?

FileEncryptionPassword

Optional file encryption password. Refer to the section "Storage Encryption" for more details.

public string FileEncryptionPassword { get; set; }

Property Value

string

LicenseKey

Your license key for the Scanbot SDK. See the "License Key" section below.

[JsonRequired]
public string LicenseKey { get; set; }

Property Value

string

LoggingEnabled

Optional boolean flag to enable logging. See the "Logging" section below.

Default is false

public bool LoggingEnabled { get; set; }

Property Value

bool

PerformanceHintApi

If set to true, PerformanceHintApi is enabled, which lead to increase of performance due of increased use of top CPU cores (Android only), also increase battery usage.

Default is true

public bool PerformanceHintApi { get; set; }

Property Value

bool

StorageBaseDirectory

Optional directory as file URI to override the default storage base directory of the Scanbot SDK. Refer to the section "Storage" for more details.

public string StorageBaseDirectory { get; set; }

Property Value

string

Methods

FromJson(string)

public static SdkConfiguration FromJson(string rawJson)

Parameters

rawJson string

Returns

SdkConfiguration