Skip to main content

Detection on the Image | Cordova Barcode Scanner

Barcode Detection from Still Images​

ScanbotBarcodeSDK.detectBarcodesOnImage(successCallback, errorCallback, args) This method provides the functionality of detecting barcodes from a still image, e.g. a JPG image from a Photo Library or other source. The image must be passed as a file URI.

Arguments:

  • imageFileUri - A valid file URI of the image (e.g. file:///some/path/image-with-barcodes.jpg). Supported image formats are JPG and PNG. Please make sure your app has the read permission to access this file.

Result:

  • result.data?.barcodes - Optional List of recognized barcodes as items. Same structure as in the startBarcodeScanner result.

Arguments

  /**
  * The input image file URI
  */
  imageFileUri: string;
  /**
  * Accepted barcode formats
  */
  barcodeFormats?: BarcodeFormat[];
  /**
  * An optional array of barcode document formats that act as a detection filter.
  * By default all supported document formats will be detected.
  */
  acceptedDocumentFormats?: BarcodeDocumentFormat[];
  /**
  * Barcode scanner engine mode. Default is NEXT_GEN
  */
  engineMode?: EngineMode;
  /**
  * Optional minimum required text length of the detected barcode.
  * The default is 0 (setting is turned off).
  * NOTE: This feature works on ITF barcodes only.
  */
  minimumTextLength?: number;
  /**
  * Optional maximum required text length of the detected barcode.
  * The default is 0 (setting is turned off).
  * NOTE: This feature works on ITF barcodes only.
  */
  maximumTextLength?: number;
  /**
  * Optional minimum required quiet zone on the barcode.
  * Measured in modules (the size of minimal bar on the barcode).
  * The default is 10.
  * NOTE: This feature works on ITF barcodes only.
  */
  minimum1DBarcodesQuietZone?: number;
  /** The GS1 handling mode. The default value is PARSE. */
  gs1HandlingMode?: Gs1HandlingMode;
  /**
  * With this option enabled, the scanner removes checks digits for UPC, EAN and MSI Plessey codes.
  * Has no effect if both single and double digit MSI Plessey checksums are enabled.
  * The default is `false`
  */
  stripCheckDigits?: boolean;
  /**
  * The checksum algorithm for MSI Plessey barcodes.
  * The default value is Mod10.
  */
  msiPlesseyChecksumAlgorithm?: MSIPlesseyChecksumAlgorithm;
  /**
  * If `true`, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. If `false` - mode is disabled. The default is `false`. Android only.
  * */
  lowPowerMode?: boolean;
  /**
  * The expected density of QR codes in an image.
  */
  codeDensity?: CodeDensity;

Want to scan longer than one minute?

Generate your free "no-strings-attached" Trial License and properly test the Scanbot SDK.

Get your free Trial License

What do you think of this documentation?

On this page

Scroll to top