Class BarcodeReader

BarcodeReader is the primary interface of the STRICH SDK.

Hierarchy

BarcodeReader

Index

Constructors

Properties

detected? onError?

Methods

destroy getVisible initialize setVisible start stop

Constructors

constructor

new BarcodeReader(configuration): BarcodeReader
Create a new BarcodeReader using a Configuration.
Parameters
- configuration: Configuration
  A configuration object.
Returns BarcodeReader

Properties

`Optional` detected

detected?: ((detections) => void)

Type declaration

- (detections): void
- User-supplied barcode detection handler.
  
  This is a synchronous call, so further processing will not happen until the handler returns.
  Parameters
  - detections: CodeDetection[]
  Returns void

`Optional` onError

onError?: ((error) => void)

Type declaration

- (error): void
- Optional user-supplied error callback.
  
  This is invoked by the BarcodeReader if an error occurred while processing frames, and is usually not recoverable.
  Parameters
  - error: Error
  Returns void

Methods

destroy

destroy(): void
Destroy this BarcodeReader instance, making it unusable.

This will release all associated resources, and should be called whenever an application no longer needs to scan.

Returns void

getVisible

getVisible(): boolean
Returns boolean
the current visibility of this BarcodeReader instance

initialize

initialize(): Promise<BarcodeReader>
Initialize the BarcodeReader instance.

Returns Promise<BarcodeReader>
A promise resolving to an initialized BarcodeReader instance, or an error object.

setVisible

setVisible(visible): Promise<void>
Show/hide the BarcodeReader instance.
Parameters
- visible: boolean
  True/false for visible/hidden
Returns Promise<void>

start

start(): Promise<void>
Start scanning for barcodes.

Returns Promise<void>

stop

stop(): Promise<void>
Stop the BarcodeReader instance.

This will temporarily suspend processing of camera frames / detection of codes.

Returns Promise<void>

Generated using TypeDoc