BarcodeDetector: detect() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{securecontext_header}}{{APIRef("Barcode Detector API")}}{{AvailableInWorkers}}{{SeeCompatTable}}
The **detect()** method of the {{domxref("BarcodeDetector")}} interface returns a {{jsxref('Promise')}} which fulfills with an {{jsxref('Array')}} of detected barcodes within an image.
Syntax
detect(imageBitmapSource)Parameters
imageBitmapSource- : Receives an image source as a parameter. This can be a {{domxref("HTMLImageElement")}}, a {{domxref("SVGImageElement")}}, a {{domxref("HTMLVideoElement")}}, a {{domxref("HTMLCanvasElement")}}, an {{domxref("ImageBitmap")}}, an {{domxref("OffscreenCanvas")}}, a {{domxref("VideoFrame")}}, a {{domxref('Blob')}} of type image or an {{domxref('ImageData')}} object.
Return value
Returns a {{jsxref('Promise')}} which fulfills with an array of DetectedBarcode objects with the following properties:
boundingBox- : A {{domxref('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 supported barcode format).
rawValue- : A string decoded from the barcode data.
Exceptions
- {{jsxref("TypeError")}}
- : Thrown if no parameter is specified or the
typeis not that of anImageBitmapSource. SecurityError{{domxref("DOMException")}}- : Thrown if the
imageBitmapSourcehas an origin and is not the same as the document's origin, or if theimageBitmapSourceis a {{domxref('HTMLCanvasElement')}} and its origin-clean flag is set tofalse. InvalidStateError{{domxref("DOMException")}}- : Thrown if the
imageBitmapSourceis an {{domxref('HTMLImageElement')}} and is not fully decoded or decoding failed, or is an {{domxref('HTMLVideoElement')}} and its {{domxref('HTMLMediaElement.readyState', 'readyState')}} isHAVE_NOTHINGorHAVE_METADATA.
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.rawValue));
})
.catch((err) => {
console.error(err);
});Specifications
{{Specifications}}
Browser compatibility
{{Compat}}