OWL
data_display
Barcode Video Scanner
Odoo 19 OWL component — Barcode Video Scanner (core)
Live preview
Interactive
Source excerpt
web/static/src/core/barcode/barcode_video_scanner.js
/* global BarcodeDetector */
import { browser } from "@web/core/browser/browser";
import { delay } from "@web/core/utils/concurrency";
import { loadJS } from "@web/core/assets";
import { isVideoElementReady, buildZXingBarcodeDetector } from "./ZXingBarcodeDetector";
import { CropOverlay } from "./crop_overlay";
import { Component, onMounted, onWillStart, onWillUnmount, status, useRef, useState } from "@odoo/owl";
import { _t } from "@web/core/l10n/translation";
import { pick } from "@web/core/utils/objects";
export class BarcodeVideoScanner extends Component {
static template = "web.BarcodeVideoScanner";
static components = {
CropOverlay,
};
static props = {
cssClass: { type: String, optional: true },
facingMode: {
type: String,
validate: (fm) => ["environment", "left", "right", "user"].includes(fm),
},
close: { type: Function, optional: true },
onReady: { type: Function, optional: true },
onResult: Function,
onError: Function,
placeholder: { type: String, optional: true },
delayBetweenScan: { type: Number, optional: true },
};
static defaultProps = {
cssClass: "w-100 h-100",
};
/**
* @override
*/
setup() {
this.videoPreviewRef = useRef("videoPreview");
this.detectorTimeout = null;
this.stream = null;
this.detector = null;
this.overlayInfo = {};
this.zoomRatio = 1;
this.scanPaused = false;
this.state = useState({
isReady: false,
});
onWillStart(async () => {
let DetectorClass;
// Use Barcode Detection API if available.
// As support is still bleeding edge (mainly Chrome on Android),
// also provides a fallback using ZXing library.
if ("BarcodeDetector" in window) {
DetectorClass = BarcodeDetector;
} else {
await loadJS("/web/static/lib/zxing-library/zxing-library.js");
DetectorClass = buildZXingBarcodeDetector(window.ZXing);
}
const formats = await DetectorClass.getSupportedFormats();
this.detector = new DetectorClass({ formats });
});
onMounted(async () => {
const constraints = {
video: { facingMode: this.props.facingMode },
audio: false,
};
try {
this.stream = await browser.navigator.mediaDevices.getUserMedia(constraints);
} catch (err) {
const errors = {
NotFoundError: _t("No device can be found."),
NotAllowedError: _t("Odoo needs your authorization first."),
};
const errorMessage = _t("Could not start scanning. %(message)s", {
message: errors[err.name] || err.message,
});
this.props.onError(new Error(errorMessage));
return;
}
if (!this.videoPreviewRef.el) {
this.cleanStreamAndTimeout();
const errorMessage = _t("Barcode Video Scanner could not be mounted properly.");
this.props.onError(new Error(errorMessage));
return;
}
this.videoPreviewRef.el.srcObject = this.stream;
const ready = await this.isVideoReady();
if (!ready) {
return;
}
const { height, width } = getComputedStyle(this.videoPreviewRef.el);
const divWidth = width.slice(0, -2);
const divHeight = height.slice(0, -2);
const tracks = this.stream.getVideoTracks();
if (tracks.length) {
const [track] = tracks;
const settings = track.getSettings();
this.zoomRatio = Math.min(divWidth / settings.width, divHeight / settings.height);
this.addZoomSlider(track, settings);
}
this.detectorTimeout = setTimeout(this.detectCode.bind(this), 100);
});
onWillUnmount(() => this.cleanStreamAndTimeout());
}
cleanStreamAndTimeout() {
clearTimeout(this.detectorTimeout);
this.detectorTimeout = null;
if (this.stream) {
this.stream.getTracks().forEach((track) => track.stop());
this.stream = null;
}
}
isZXingBarcodeDetector() {
return this.detector && this.detector.__proto__.constructor.name === "ZXingBarcodeDetector";
}
Registry / API
- Registry name
BarcodeVideoScanner- Category
—- Module
web- Slug
barcode-video-scanner- Nav group
data_display