Class CaptureVisionRouter

Adds a CapturedResultFilter object to filter non-essential results. It will return the CapturedResultFilter added itself, convenient to use removeFilter method.

Code snippet:

let router = await CaptureVisionRouter.getInstance();
let receiver = router.addFilter(new MultiFrameResultCrossFilter());
//...
router.removeFilter(filter);
Copy

Adds a CapturedResultReceiver object as the receiver of captured results. It will return the receiver added itself, convenient to use removeResultReceiver method.

Code Snippet:

let router = await CaptureVisionRouter.getInstance();
let receiver = router.addResultReceiver({
     onCapturedResultReceived: result => {
         // Do something with the result
     },
});
Copy

Processes ImageData object to derive important information.

Code Snippet:

let cameraEnhancer = CameraEnhancer.getInstance();
let router = CaptureVisionRouter.getInstance();
let imageData = cameraEnhancer.getImage();
let result = router.capture(imageData, "ReadSingleBarcode");
for(let i = 0; i < result.items.length; i++) {
    //...
}
Copy

Processes a file containing a single image to derive important information.

Code Snippet:

let router = CaptureVisionRouter.getInstance();
let result = router.capture("absolute-image-file-path", "ReadSingleBarcode");
for(let i = 0; i < result.items.length; i++) {
    //...
}
Copy

Processes An ArrayBuffer object that points to a file in memory to derive important information.

Get a simplified settings object for the specified template name.

Configures runtime settings using a provided JSON string, which contains settings for one or more CaptureVisionTemplates.

Configures runtime settings using a provided JSON file, which contains settings for one or more CaptureVisionTemplates.

Get a JSON string that contains settings for the specified templateName.

Generates a JSON file download containing the settings for the specified templateName and saved to specified file path.

Removes all CapturedResultReceiver object added in.

Removes the specified MultiFrameResultCrossFilter object.

Removes the specified CapturedResultReceiver object.

Code Snippet:

let router = await CaptureVisionRouter.getInstance();
let receiver = router.addResultReceiver({
     onCapturedResultReceived: result => {
         // Do something with the result
     },
});
//...
router.removeResultReceiver(receiver);
Copy

Restores all runtime settings to their original default values.

Sets up an image source to provide images for continuous processing.

Code Snippet:

let router = await CaptureVisionRouter.getInstance();
let cameraEnhancer = CameraEnhancer.getInstance();
router.setInput(cameraEnhancer);
Copy

Initiates a capturing process based on a specified template. This process is repeated for each image fetched from the source.

Code Snippet:

let router = CaptureVisionRouter.getInstance();
await router.startCapturing('ReadSingleBarcode');
Copy

Stops the capturing process.

Code Snippet:

let router = await CaptureVisionRouter.getInstance();
await router.startCapturing("ReadSingleBarcode");
// ...
router.stopCapturing();
Copy

Updates the specified templateName with an updated SimplifiedCaptureVisionSettings object. Defined properties will be updated, and undefined properties will retain their original values.

Code Snippet:

let router = CaptureVisionRouter.getInstance();
let settings = {
   timeout: 1000,
   maxParallelTasks: 1,
   barcodeSettings: {
     expectedBarcodesCount: 999,
     barcodeFormatIds: EnumBarcodeFormats.BF_ONED | EnumBarcodeFormats.BF_QR_CODE,
   }
};
//Only timeout, maxParallelTasks, expectedBarcodesCount and barcodeFormatIds will be updated.
router.updateSettings("ReadSingleBarcode", settings);

Copy

Get the singleton instance of CaptureVisionRouter.

This method ensures that only one instance of CaptureVisionRouter is created and reused throughout the application. If an instance already exists, it will return the existing one. Otherwise, it will create a new instance and return it.