scandit-sdk
Version:
Scandit Barcode Scanner SDK for the Web
46 lines (45 loc) • 1.64 kB
TypeScript
import { Barcode } from "./barcode";
import { ImageSettings } from "./imageSettings";
/**
* A result of a scanning operation on an image.
*/
export declare class ScanResult {
/**
* The list of barcodes found in the image (can be empty).
*/
readonly barcodes: Barcode[];
/**
* The image data given as a byte array, formatted accordingly to the set settings ([[imageSettings]]).
*/
readonly imageData: Uint8ClampedArray;
/**
* The configuration object defining the properties of the processed image ([[imageData]]).
*/
readonly imageSettings: ImageSettings;
/**
* @hidden
*
* The list of manually rejected barcodes.
*/
readonly rejectedCodes: Set<Barcode>;
/**
* @hidden
*
* Create a ScanResult instance.
*
* @param barcodes The list of barcodes found in the image.
* @param imageData The image data given as a byte array, formatted accordingly to the set settings.
* @param imageSettings The configuration object defining the properties of the processed image.
*/
constructor(barcodes: Barcode[], imageData: Uint8ClampedArray, imageSettings: ImageSettings);
/**
* Prevent playing a sound, vibrating or flashing the GUI for a particular code.
* If all codes in the result are rejected (or no barcode is present), sound, vibration and GUI flashing will be
* suppressed.
*
* Rejected codes will still be part of the [[ScanResult.barcodes]] property like all other codes.
*
* @param barcode The barcode to be rejected.
*/
rejectCode(barcode: Barcode): void;
}