mebjas/html5-qrcode
Html5 Qrcode
html5-qrcode is a client-side JavaScript library that enables QR code and barcode scanning directly in a web browser, processing live video from a device camera or decoding codes from uploaded image files without any server-side involvement. The library handles real-time scanning from continuous camera feeds with adjustable frame rates and scanning regions, while also supporting file-based decoding for static images.
The scanner offers configurable behavior through runtime settings, allowing developers to adjust scanning speed, viewfinder region, aspect ratio, and restrict decoding to specific 1D or 2D code formats. It provides callback-driven result handling for successful code detection, scan failures, and video stream errors, with automatic scan termination after a successful read to prevent redundant processing. Camera controls include inline switching between available cameras, torch and zoom adjustment during scanning, and the ability to capture high-resolution video for small or distant codes.
The library supports both camera and file scanning modes, which can be configured independently or combined into a single interface. It includes a multilingual interface system for displaying the scanner in languages other than English, and provides programmatic control to stop scanning sessions and clean up camera resources on demand.
Features
- Browser-Based Scanners - Enables QR code and barcode scanning directly in a web browser from camera or image files.
- Barcode Decoders - Decodes QR codes and barcodes from user-selected image files entirely on the client side.
- Camera Feed Decoders - Captures live camera video and decodes QR codes and barcodes in real time using browser media APIs.
- QR Codes - Provides real-time QR code scanning from continuous camera video with adjustable frame rate and region.
- Camera-Based Scanners - Captures live camera video and decodes QR codes and barcodes in real time within a web page.
- Camera QR Code Scanners - Captures live camera video and decodes QR codes and barcodes in real time from the feed.
- Image File Barcode Decoders - Decodes QR codes and barcodes from user-selected image files without server uploads.
- Dual-Mode Scanners - Provides a unified interface for scanning codes from both camera and image file sources.
- Scan Result Callbacks - Ships callback-driven result handling for successful code detection and scan or video failures.
- JavaScript - Reads 1D and 2D barcodes from camera video or image files using JavaScript without server uploads.
- Automatic Scan Terminations - Automatically stops the camera and scanning after a successful code read to prevent redundant processing.
- Client-Side Barcode Decodings - Decodes QR codes and barcodes from user-selected image files entirely on the client side using JavaScript.
- Multi-Format Barcode Recognitions - Decodes a configurable subset of 1D and 2D barcode formats using a unified scanning algorithm.
- QR Code Scanner Libraries - Captures device camera video and decodes QR codes in real time with configurable scanning behavior.
- Browser-Based Camera Scannings - Captures live camera video and decodes QR codes and barcodes in real time within the browser.
- Callback-Driven Request Handling - Invokes user-defined callbacks for successful code detection, scan failures, and video stream errors.
- Scan Success and Failure Callbacks - Invokes user-defined callbacks when a code is successfully decoded or when scanning fails.
- Barcode Detection Accuracy Enhancements - Enhances the core scanning algorithms to reliably detect codes that currently fail or produce errors.
- Camera or File Scanning Mode Selections - Configures the scanner to use only the camera, only file upload, or both, and sets the default scan mode.
- Inline Camera Switchers - Switches between available cameras inline without interrupting the active scanning session.
- Automatic Scan Termination - Automatically stops the camera and scanning process after a successful code read to prevent redundant scans.
- Scanning Configurations - Provides runtime configuration for scanning speed, region, code formats, and camera controls.
- Scan Scope Restrictions - Limits the scanner to decode only a user-defined subset of QR or barcode formats.
- Scan Session Termination - Provides programmatic control to stop scanning sessions and release camera resources on demand.
- Runtime Scanning Configurations - Provides a runtime configuration object to adjust scanning speed, region, aspect ratio, and supported code formats.
- Failure Event Handling - Invokes a user-defined function when no code is detected or when the camera fails to start.
- Scan Failure Callbacks - Invokes a user-defined callback when the scanner fails to read a code or encounters a video stream error.
- Inline Camera Switchings - Switches between available cameras inline without stopping the current scan session.
- Automatic Scan Termination - Automatically stops the camera and scanning process after a successful code read to prevent redundant scans.
- Scanner Behavior Configurations - Adjusts scanning speed, viewfinder region, aspect ratio, mirror handling, and supported code formats via a configuration object.
- Scanner Performance and Region Configurations - Adjusts frames per second, scanning region, aspect ratio, and flip behavior to balance scanning speed and accuracy.
- Camera Flash and Zoom Controls During Scanning - Toggles the device torch and adjusts camera zoom while scanning to improve readability in low light or for distant codes.
- Camera Torch and Zoom Controls - Controls device torch and camera zoom during scanning to improve readability in low light or for distant codes.
- Barcode Format Filters - Ships configurable format filtering to restrict scanning to specific 1D and 2D code types.
- Barcode Format Restrictions - Restricts the scanner to recognize only a user-defined subset of QR or barcode formats.
