Web/API/BarcodeDetector/detect

Draft This page is not complete.

Secure contextThis feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The detect() method of the BarcodeDetector interface returns a Promise which fulfills with an Array of detected barcodes within an image.

Syntax

var detectedBarcode = BarcodeDetector.detect(ImageBitmapSource);

Parameters

image

Receives an ImageBitmapSource as a parameter. This can be an element, a Blob of type image or an ImageData object.

Return value

Returns a Promise which fulfills with an array of detectedBarcode objects with the following properties:

• boundingBox: A DOMRectReadOnly, which returns the dimensions of a rectangle representing the extent of a detected barcode, aligned with the image.
• cornerPoints: The x and y co-ordinates of the four corner points of the detected barcode relative to the image, starting with the top left and working clockwise. This may not be square due to perspective distortions within the image.
• format: The detected barcode format. (For a full list of formats see the Barcode Detection API overview page).
• rawValue: A String decoded from the barcode data.

Exceptions

TypeError

No parameter is specified or the type is not that of an ImageBitmapSource.

Examples

This example uses the detect() method to detect the barcodes within the given image. These are iterated over and the barcode data is logged to the console.

barcodeDetector.detect(imageEl)
  .then(barcodes => {
    barcodes.forEach(barcode => console.log(barcode.rawData));
  }
  .catch(err => {
    console.log(err);
  })

Specifications

Specification	Status	Comment
Accelerated Shape Detection in ImagesThe definition of 'BarcodeDetector.detect()' in that specification.	Draft	Initial definition.

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
detect Experimental'Non-standard'	Chrome Full support 83	Edge Full support 83	Firefox No support No	IE No support No	Opera Full support Yes	Safari No support No	WebView Android Full support 83	Chrome Android Full support 83	Firefox Android No support No	Opera Android Full support Yes	Safari iOS No support No	Samsung Internet Android Full support 13.0

Legend

Full support  

Full support

No support  

No support

Experimental. Expect behavior to change in the future.'

Experimental. Expect behavior to change in the future.

Non-standard. Expect poor cross-browser support.'

Non-standard. Expect poor cross-browser support.

BarcodeDetector.detect() by Mozilla Contributors is licensed under CC-BY-SA 2.5.