Class AnylineJS

Properties

camera isLoaded onError onLoad onPerformanceLog onResult onScannedBarcodes

Methods

dispose getFrame getState handleImageRequest pauseScanning preload resumeScanning setFocusDistance startScanning stopScanning

Properties

camera

camera: CameraAPI

Camera API

isLoaded

isLoaded: boolean = false

onError

onError: ((error: LegacyErrorObject) => void)

Callback called when some (not all) Errors occur

Type declaration

    • (error): void

    • Parameters

      Returns void

Deprecated

since version 31.0.0 (Errors should be catched when calling the methods, which provides proper stack-trace)

onLoad

onLoad: ((video: HTMLVideoElement) => void)

Callback called when scanning is started

Type declaration

    • (video): void

    • Parameters

      • video: HTMLVideoElement

        video Element

      Returns void

Deprecated

since version 31.0.0 (startScanning is now resolving a promise)

onPerformanceLog

onPerformanceLog: ((perflog: any) => void)

Callback called when a scan yielded in a performance log

Type declaration

    • (perflog): void

    • Parameters

      • perflog: any

        object containing the performance log

      Returns void

onResult

onResult: ((result: AnylineJSResult) => void)

Callback called when a scan yielded in a result

Type declaration

    • (result): void

    • Parameters

      Returns void

onScannedBarcodes

onScannedBarcodes: ((result: AnylineJSResult) => void)

Callback called when any Barcodes are detected.

Type declaration

    • (result): void

    • Parameters

      Returns void

Methods

dispose

getFrame

  • getFrame(): undefined | ImageObject

  • Returns an object with the full image and its cutout from the SDK.

    Returns undefined | ImageObject

    • An object with full image and its cutout, or undefined if no image is in the buffer.

getState

handleImageRequest

pauseScanning

  • pauseScanning(): void

  • Pause the scan process

    Returns void

    Throws

    NotScanningError This exception is thrown if anylineJS was not started before calling this method

preload

resumeScanning

setFocusDistance

startScanning

  • startScanning(): Promise<null | HTMLVideoElement>

  • Starts the scan process

    Returns Promise<null | HTMLVideoElement>

    A promise resolving the video element of the feed

    Throws

    PermissionError This exception is thrown if the camera access was denied

    Throws

    AnylineError This exception is thrown if something internally is wrong like licensing issues

    Throws

    DisposedError This exception is thrown if anylineJS is already disposed

stopScanning

  • stopScanning(): void

  • Stops the scan process

    Returns void

    Throws

    NotScanningError This exception is thrown if anylineJS was not started before calling this method

Settings

Member Visibility

On This Page

Properties
Methods