Class BarcodeReader

constructor

• new BarcodeReader(configuration: Configuration): BarcodeReader

  Create a new BarcodeReader using a Configuration object.

  Parameters

  • configuration: Configuration

    A configuration object.

  Returns BarcodeReader

  Remarks

  This will perform some basic checks, such as if the SDK was initialized, the browser supports the required APIs and the host element is visible and has a non-zero size. This will not access the camera yet, that happens in the BarcodeReader#initialize method.

OptionalcameraSelector

Optionaldetected

OptionalonError

destroy

• destroy(): Promise<void>

  Destroy this BarcodeReader instance, making it unusable.

  Returns Promise<void>

  Promise that resolves when the BarcodeReader and its associated resources are fully destroyed.

  Remarks

  This will release all associated resources, including the camera stream, and should be called whenever an application no longer needs the BarcodeReader.

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 SdkError object.

  Remarks

  This will attempt to acquire a camera stream, so it is essential that the returned Promise is awaited, and that measures are taken so that the returned BarcodeReader instance is destroyed when it is no longer need. That will free the camera stream for subsequent use.

  If you are getting camera-related initialization errors, the most likely cause is that you are attempting to initialize a BarcodeReader and the camera feed has not been released yet.

setFlashlight

• setFlashlight(enabled: boolean): Promise<void>

  Programmatically toggle the flashlight if the device supports it.

  Parameters

  • enabled: boolean

    True to enable the flashlight, false to disable it

  Returns Promise<void>

  Remarks

  This method will do nothing if the BarcodeReader is not initialized or has been destroyed.

setVisible

• setVisible(visible: boolean): Promise<void>

  Show or hide the BarcodeReader instance.

  Parameters

  • visible: boolean

    True to display the BarcodeReader, false to hide it

  Returns Promise<void>

  Remarks

  This will not release the camera stream.

setZoom

• setZoom(enabled: boolean): Promise<void>

  Programmatically zoom the camera feed if the device supports it.

  Parameters

  • enabled: boolean

    True to enable zoom, false to disable it

  Returns Promise<void>

  Remarks

  This method will do nothing if the BarcodeReader is not initialized or has been destroyed.

start

• start(): Promise<void>

  Start barcode recognition.

  Returns Promise<void>

  Remarks

  The BarcodeReader instance must have previously been successfully initialized using the BarcodeReader#initialize method.

stop

• stop(): Promise<void>

  Stop barcode recognition.

  Returns Promise<void>

  Remarks

  This will suspend camera frame processing/barcode recognition, but will not release the camera stream. If you no longer intend to use the BarcodeReader instance, call BarcodeReader#destroy afterward.

  If you intend to only temporarily stop recognition of barcodes and resume later, call BarcodeReader#start again.