Interface InitializationOptions

interface InitializationOptions {
    allowThreads?: boolean;
    bestCameraDetectionStrategy?: CameraDetectionStrategy;
    enginePath: string;
    licenseKey: string;
    onComplete?: ((e?) => void);
    requestSuffix?: string;
    verboseLogging?: boolean;
}

Properties

allowThreads? bestCameraDetectionStrategy? enginePath licenseKey onComplete? requestSuffix? verboseLogging?

Properties

Optional allowThreads

allowThreads?: boolean

Determines whether the SDK should use multithreading. Defaults to true. Multithreading will only affect supported Android devices and desktop browsers. Multithreading on iOS is currently not supported. On supported devices, multithreading will improve performance significantly. Note that multithreading will only work on crossOriginIsolated sites. To enable this for your site, certain HTTP headers need to be set. Please consult our documentation for more information. If multithreading was requested but the site is not in a crossOriginIsolated context, the SDK will print a warning and fallback to single-threaded operation.

Optional bestCameraDetectionStrategy

bestCameraDetectionStrategy?: CameraDetectionStrategy

On devices with multiple cameras, it is difficult to choose which camera to use for scanning. You can choose from several different automatic detection strategies described by CameraDetectionStrategy. Defaults to FAST_DEFERRED.

enginePath

enginePath: string

Location of the Core WebAssembly Engine. Mandatory.

licenseKey

licenseKey: string

Scanbot Web SDK License key. Required

Optional onComplete

onComplete?: ((e?) => void)

Type declaration

    • (e?): void

    • The completion handler is called when deferred initialization is complete, i.e. when the WASM binary has been loaded. This will only be called after the SDK has been successfully initialized or if an error occurred, in which case the error parameter will be evaluated, otherwise undefined.

      Parameters

      • Optional e: Error

      Returns void

Optional requestSuffix

requestSuffix?: string

The requestSuffix is appended to the HTTP requests made by the SDK to load necessary WASM and JS files. It is meant to avoid any caching issues that may arise when the SDK is updated. Defaults to '?CURRENT_SDK_VERSION'.

Optional verboseLogging

verboseLogging?: boolean

Determines whether the SDK should log debug messages. Defaults to false.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc