qr_plus library

Classes

Address
An address.
Barcode
Represents a single recognized barcode and its value.
BarcodeBytes
Represents the raw bytes of a barcode.
BarcodeCapture
This class represents a scanned barcode.
BarcodeOverlay
This widget represents an overlay that paints the bounding boxes of detected barcodes.
BarcodePainter
A CustomPainter that draws the barcode as an outlined barcode box with rounded corners and a displayed value.
CalendarEvent
A calendar event extracted from a QRCode.
ContactInfo
A person's or organization's business card. For example a VCARD.
DecodedBarcodeBytes
Decoded barcode bytes, available on Android and web.
DecodedVisionBarcodeBytes
Decoded barcode bytes from the Apple Vision API.
DriverLicense
A driver license or ID card.
Email
An email message from a 'MAILTO:' or similar QRCode type.
GeoPoint
GPS coordinates from a GEO: or similar QRCode type.
MobileScanner
This widget displays a live camera preview for the barcode scanner.
MobileScannerErrorDetails
The raw error details for a MobileScannerException.
MobileScannerPlatform
The platform interface for the mobile_scanner plugin.
MobileScannerState
This class represents the current state of a MobileScannerController.
MobileScannerViewAttributes
This class defines the attributes for the mobile scanner view.
PersonName
A person's name, divided into individual components.
Phone
Phone number information from a barcode.
QrBitBuffer
QrCode
QrDataModuleStyle
Styling options for data module.
QrEmbeddedImageStyle
Styling options for any embedded image overlay
QrErrorCorrectLevel
QrEyeStyle
Styling options for finder pattern eye.
QrImage
Renders the encoded data from a QrCode in a portable format.
QrImageView
A widget that shows a QR code.
QrPainter
A CustomPainter object that you can use to paint a QR code.
QrPlusMode
This class represents different levels of security to be used within package:qr_plus. Each layer adds more security to the data transfer, and the layer to be used and their parameters are determined by the package user to fit their needs. Each layer adds the layer specific configuration on top of the previouse layers configuration. The available layers (from least to most secure) are:
QrPlusReader
A widget for reading QR codes with all the secyrity features provided by package:qr_plus.
QrPlusReaderController
A wrapper around MobileScannerController, which exposes the same methods while deprecating MobileScannerController.barcodes. It is necessary to deprecate it, since the data that the scanner is reading, is the raw data which has to be processed and decoded by package:qr_plus before showing to the package user.
QrPlusRenderer
A widget for rendering a QR code with all the secyrity features provided by package:qr_plus.
QrValidationResult
Captures the status or a QR code validation operations, as well as the rendered and validated data / object so that it can be used in any secondary operations (to avoid re-rendering). It also keeps any exception that was thrown.
QrValidator
A utility class for validating and pre-rendering QR code data.
QrVersions
This class only contains special version codes. QR codes support version numbers from 1-40 and you should just use the numeric version directly.
ScanWindowOverlay
This widget represents an overlay that paints a scan window cutout.
ScanWindowPainter
This class represents a CustomPainter that draws a scanWindow rectangle.
ScanWindowUtils
A utility class for calculating scan window sizes.
SelectCamera
An implementation of SwitchCameraOption that selects a specific camera direction and/or lens type.
SMS
An sms message from a SMS: or similar QRCode type.
StartOptions
This class defines the different start options for the mobile scanner.
SwitchCameraOption
The options for a switch camera request.
ToggleDirection
An implementation of SwitchCameraOption that toggles between CameraFacing.front and CameraFacing.back.
ToggleLensType
An implementation of SwitchCameraOption that cycles through available lens types on the current camera facing direction.
UrlBookmark
A URL and title from a MEBKM: or similar QRCode type.
WiFi
Wireless network information from BarcodeType.wifi barcodes.

Enums

AddressType
Address type constants.
BarcodeFormat
This enum defines the different barcode formats.
BarcodeType
Barcode value type constants.
CameraFacing
The facing of a camera.
CameraLensType
The type of camera lens based on focal length.
DetectionSpeed
The detection speed of the scanner.
EmailType
Email format type constants.
EncryptionType
Wifi encryption type constants.
FinderPatternPosition
Enumeration representing the three finder pattern (square 'eye') locations.
MobileScannerAuthorizationState
The authorization state of the scanner.
MobileScannerErrorCode
This enum defines the different error codes for the mobile scanner.
PhoneType
Phone number format type constants.
QrCodeElement
Represents a specific element / part of a QR code. This is used to isolate the different parts so that we can style and modify specific parts independently.
QrDataModuleShape
Enumeration representing the shape of Data modules inside QR.
QrEyeShape
Enumeration representing the finder pattern eye's shape.
QrPlusAuthenticity
A status which indicates whether the QR code is authentic or not. It is up to the user of this package to decide what to do with the data based on the authenticity status. Note: QrPlusAuthenticity.noNetwork and QrPlusAuthenticity.screenRecording do not guaurantee that the data is not authentic. They only indicate the possibility that there is some sort of cheating attempt going on.
QrPlusReadError
Describes why a scanned QR code could not be turned into usable data.
QrValidationStatus
The status of the QR code data you requested to be validated.
TorchState
The state of the flashlight.
WebBarcodeReader
The barcode detection backend to use on the web platform.

Functions

calculateBoxFitRatio(BoxFit boxFit, Size cameraPreviewSize, Size size) → ({double heightRatio, double widthRatio})
Calculate the scaling ratios for width and height to fit the provided cameraPreviewSize into the specified size, based on the specified boxFit.

Typedefs

QrErrorBuilder = Widget Function(BuildContext context, Object? error)
A function type to be called when any form of error occurs while painting a QrImageView.

Exceptions / Errors

InputTooLongException
MobileScannerBarcodeException
This class represents an exception thrown by the MobileScannerController when a barcode scanning error occurs when processing an input frame.
MobileScannerException
This class represents an exception thrown by the MobileScannerController.
QrEmbeddedImageException
An exception that is thrown when something goes wrong with the ImageProvider for the embedded image of a QrImageView or QrPainter.
QrUnsupportedVersionException
An exception that is thrown when an invalid QR code version / type is requested.