Interface AnylineJSParams

interface AnylineJSParams {
    anylinePath?: string;
    config?: PluginConfig;
    correlationId?: string;
    coverVideo?: boolean;
    debugAnyline?: string | boolean;
    element: HTMLElement;
    enableCaching?: boolean;
    estimateMainCamera?: boolean;
    flashOnResult?: boolean;
    hapticFeedback?: boolean;
    initialFlashOn?: boolean;
    landscapeOrientation?: LockOrientation;
    license: string;
    loadingScreen?: string;
    lockPortraitOrientation?: LockOrientation;
    mediaConstraints?: MediaStreamConstraints;
    mirrorOnDesktop?: boolean;
    preload?: boolean;
    preloadCallback?: (() => void);
    preset?: string;
    retryCameraAccess?: boolean;
    scaleDown?: boolean;
    slowMessageTimeout?: number;
    throttleImagePass?: number;
    useFullUrlBundleId?: boolean;
    videoSrc?: string;
    viewConfig?: ViewConfig;
    wasmPath?: string;
}

Properties

anylinePath? config? correlationId? coverVideo? debugAnyline? element enableCaching? estimateMainCamera? flashOnResult? hapticFeedback? initialFlashOn? landscapeOrientation? license loadingScreen? lockPortraitOrientation? mediaConstraints? mirrorOnDesktop? preload? preloadCallback? preset? retryCameraAccess? scaleDown? slowMessageTimeout? throttleImagePass? useFullUrlBundleId? videoSrc? viewConfig? wasmPath?

Properties

OptionalanylinePath

anylinePath?: string

anylinePath - Path to anylineJS data assets (defaults to cdn hosted assets)

Optionalconfig

config?: PluginConfig

config - AnylineJS configuration object

OptionalcorrelationId

correlationId?: string

correlationId - UUIDv4 string to define user Correlation ID

OptionalcoverVideo

coverVideo?: boolean

coverVideo - [default: true] Reverts a letterbox fix (not recommended to set to false)

OptionaldebugAnyline

debugAnyline?: string | boolean

debugAnyline - Flag to output more verbose logs | pass 'screen' to additionally render logging overlay (beta)

element

element: HTMLElement

element - HTMLElement where anylineJS should be mounted into

OptionalenableCaching

enableCaching?: boolean

enableCaching - [default: true] Enable caching mechanism for large binary data

OptionalestimateMainCamera

estimateMainCamera?: boolean

estimateMainCamera - [default: true] Flag to disable camera estimation (not recommended)

OptionalflashOnResult

flashOnResult?: boolean

Activate flash feedback on mobile devices.

OptionalhapticFeedback

hapticFeedback?: boolean

Activate haptic feedback on mobile devices.

OptionalinitialFlashOn

initialFlashOn?: boolean

initialFlashOn - [default: false] starts scanning with camera flash state (only Android Chrome support)

OptionallandscapeOrientation

landscapeOrientation?: LockOrientation

lockOrientation - If set locks the screen orientation to landscape and overrides 'lockPortraitOrientation'. (Android)

license

license: string

license - AnylineJS license string

OptionalloadingScreen

loadingScreen?: string

loadingScreen - HTML string to replace the default loader (<div>loading...</div>)

OptionallockPortraitOrientation

lockPortraitOrientation?: LockOrientation

lockOrientation - If set locks the screen orientation to portrait. (Android)

OptionalmediaConstraints

mediaConstraints?: MediaStreamConstraints

mediaConstraints - overwrite mediaConstraints of the camera feed (i.E to use a certain resolution or a specific camera)

OptionalmirrorOnDesktop

mirrorOnDesktop?: boolean

mirrorOnDesktop - (default: true) disable mirroring on desktop browsers (i.E if you are using a back-facing camera on desktop)

Optionalpreload

preload?: boolean

preload - preloads the assets by a given preset (eg. 'barcode')

OptionalpreloadCallback

preloadCallback?: (() => void)

preloadCallback - set a callback to execute custom code after all assets were loaded. Callback will override the default behavior.

Optionalpreset

preset?: string

preset - Module preset

OptionalretryCameraAccess

retryCameraAccess?: boolean

retryCameraAccess - Flag if the system should retry camera access with fallback default media constraints

OptionalscaleDown

scaleDown?: boolean

scaleDown - [default: false] Scales down the processed image for potential performance boost in a few use cases (barcode)

OptionalslowMessageTimeout

slowMessageTimeout?: number

slowMessageTimeout - [default: 14000] Sets a timeout to start scanning

OptionalthrottleImagePass

throttleImagePass?: number

throttleImagePass - throttle the time between processing images (in ms)

OptionaluseFullUrlBundleId

useFullUrlBundleId?: boolean

useFullUrlBundleId - Flag to consider the whole url path as the bundleId (i.E example.com/apps/scanner vs. example.com)

OptionalvideoSrc

videoSrc?: string

videoSrc - Https url pointing to a video stream to exchange the camera feed (for debugging, testing purposes)

OptionalviewConfig

viewConfig?: ViewConfig

viewConfig - Appearance configuration of the cutout

OptionalwasmPath

wasmPath?: string

Path to the web assembly binary.

Settings

Member Visibility

On This Page

Properties