.NET MAUI API reference
Every method, setting, enum and result of the barKoder .NET MAUI SDK, grouped by what you do with it.
Scanning & session #
StartCamera #
void StartCamera()Starts the camera for barcode scanning.
StartScanning #
void StartScanning(IBarkoderDelegate barkoderDelegate)Starts scanning for barcodes.
ScanImage #
void ScanImage(string base64Image, IBarkoderDelegate barkoderDelegate)Scan from base64 image string.
StopScanning #
void StopScanning()Stops the barcode scanning process.
PauseScanning #
void PauseScanning()Pauses the barcode scanning process.
FreezeScanning #
void FreezeScanning()Freezes the current AR scanning session by capturing a still image from the camera feed. Use only when AR mode is enabled to temporarily freeze the view while keeping overlays visible.
UnfreezeScanning #
void UnfreezeScanning()Unfreeze Scanning the current AR scanning session by capturing a still image from the camera feed. Use only when AR mode is enabled to temporarily unfreeze the view while keeping overlays visible.
ResetARCache #
void ResetARCache()Clears all cached barcode results from the current AR scanning session. Available only when AR mode is enabled.
CaptureImage #
void CaptureImage()Captures the latest available camera frame and returns it through the IBarkoderDelegate.DidFinishScanning callback (without decoding barcodes). Must be used after starting the camera with StartScanning().
SelectVisibleBarcodes #
void SelectVisibleBarcodes()Selects all barcodes that are currently visible in AR mode.
ConfigureBarkoder #
void ConfigureBarkoder(BarkoderConfig BarkoderConfig)Configures the Barkoder functionality based on the provided configuration. Serialized to JSON with Newtonsoft.Json.
Camera #
SetFlashEnabled #
void SetFlashEnabled(bool enabled)Sets the flash (torch) on or off for barcode scanning.
SetZoomFactor #
void SetZoomFactor(float zoomFactor)Sets the zoom factor for the camera used in barcode scanning.
GetCurrentZoomFactor #
float GetCurrentZoomFactor()Returns -1 when the handler is not available.
SetCamera #
void SetCamera(BarkoderCameraPosition position)Sets the camera to be used for scanning (back/front).
GetAvailableCameras #
List<Dictionary<string, string>> GetAvailableCameras()Gets a list of available cameras on the device. Available on Mac Catalyst and Windows. Each dictionary has id and name keys. Returns an empty list when the handler is not available.
SetCameraById #
void SetCameraById(string cameraId)Sets the active camera by its device ID (obtained from GetAvailableCameras). Available on Mac Catalyst and Windows.
SetDynamicExposure #
void SetDynamicExposure(int dynamicExposure)Sets the camera's exposure dynamically based on the provided intensity, cycling through predefined compensation values.
SetCentricFocusAndExposure #
void SetCentricFocusAndExposure(bool enabled)Sets the camera to use the center of the viewfinder for focus and exposure.
SetVideoStabilization #
void SetVideoStabilization(bool enabled)Enable or disable video stabilization for smoother video capture.
SetCustomOption #
void SetCustomOption(string optionName, int optionValue)Sets a custom decoder option by key. See details about available options and their values.
SetPinchToZoomEnabled #
void SetPinchToZoomEnabled(bool enabled)Enables or disables pinch-to-zoom functionality for the camera used in barcode scanning.
Barcode types #
SetBarcodeTypeEnabled #
void SetBarcodeTypeEnabled(BarcodeType barcodeType, bool enabled)Enables or disables the specified barcode type for scanning.
IsBarcodeTypeEnabled #
bool IsBarcodeTypeEnabled(BarcodeType barcode)Checks if a specific barcode type is enabled.
SetBarcodeTypeLengthRange #
void SetBarcodeTypeLengthRange(BarcodeType barcodeType, int min, int max)Sets the length range for a specified barcode type.
SetMsiChecksumType #
void SetMsiChecksumType(MsiChecksumType msiChecksumType)Sets the checksum type for MSI barcodes.
SetCode11ChecksumType #
void SetCode11ChecksumType(Code11ChecksumType code11ChecksumType)Sets the checksum type for Code 11 barcodes.
SetCode39ChecksumType #
void SetCode39ChecksumType(Code39ChecksumType code39ChecksumType)Sets the checksum type for Code 39 barcodes.
SetIdDocumentMasterChecksumEnabled #
void SetIdDocumentMasterChecksumEnabled(bool enabled)Controls whether the SDK requires the master checksum validation when scanning an ID document's MRZ (Machine Readable Zone).
SetDatamatrixDpmModeEnabled #
void SetDatamatrixDpmModeEnabled(bool enabled)Enables or disables the (DPM) mode for Datamatrix barcodes.
SetQRDpmModeEnabled #
void SetQRDpmModeEnabled(bool enabled)Sets whether Direct Part Marking (DPM) mode is enabled.
SetQRMicroDpmModeEnabled #
void SetQRMicroDpmModeEnabled(bool enabled)Sets whether Direct Part Marking (DPM) mode is enabled.
SetUpcEanDeblurEnabled #
void SetUpcEanDeblurEnabled(bool enabled)Enables or disables deblurring for UPC/EAN barcodes.
SetUPCEexpandToUPCA #
void SetUPCEexpandToUPCA(bool enabled)Sets whether the UPC-E barcodes should be expanded to UPC-A format.
SetUPCE1expandToUPCA #
void SetUPCE1expandToUPCA(bool enabled)Sets whether the UPC-E1 barcodes should be expanded to UPC-A format.
SetEnableMisshaped1DEnabled #
void SetEnableMisshaped1DEnabled(bool enabled)Enables or disables the decoding of misshaped 1D barcodes.
SetEnableVINRestrictions #
void SetEnableVINRestrictions(bool enabled)Sets whether Vehicle Identification Number (VIN) restrictions are enabled for scanning.
SetEnableComposite #
void SetEnableComposite(int enableComposite)Sets whether Composite Mode should be enabled when scanning.
SetDecodingSpeed #
void SetDecodingSpeed(DecodingSpeed decodingSpeed)Sets the decoding speed for barcode scanning.
SetFormattingType #
void SetFormattingType(FormattingType formattingType)Sets the formatting type for barcode scanning.
SetEncodingCharacterSet #
void SetEncodingCharacterSet(string encodingCharacterSet)Sets the encoding character set for barcode scanning.
SetBarkoderResolution #
void SetBarkoderResolution(BarkoderResolution resolution)Sets the resolution for barcode scanning.
SetPowerSavingMode #
void SetPowerSavingMode(int powerSavingMode)Increasing the level reduces CPU and battery usage by limiting frame processing.
SetDecoderMatchFilter #
void SetDecoderMatchFilter(string matchFilter)Specifies the barcode value(s) that the scanner should match.
SetDecoderReturnOnlyMatchedResults #
void SetDecoderReturnOnlyMatchedResults(bool enabled)Sets whether only results matching the configured matchFilter are returned.
Results #
SetCloseSessionOnResultEnabled #
void SetCloseSessionOnResultEnabled(bool enabled)Sets whether the session should be closed upon detecting a result during barcode scanning.
SetImageResultEnabled #
void SetImageResultEnabled(bool enabled)Enables or disables the display of image results during barcode scanning.
SetLocationInImageResultEnabled #
void SetLocationInImageResultEnabled(bool enabled)Enables or disables displaying the barcode location in the image result.
SetLocationInPreviewEnabled #
void SetLocationInPreviewEnabled(bool enabled)Enables or disables displaying the barcode location in the camera preview.
SetBarcodeThumbnailOnResultEnabled #
void SetBarcodeThumbnailOnResultEnabled(bool enabled)Enables or disables the display of barcode thumbnails in the scan results.
SetMaximumResultsCount #
void SetMaximumResultsCount(int maximumResultsCount)Sets the maximum number of results to be returned from barcode scanning.
SetThresholdBetweenDuplicatesScans #
void SetThresholdBetweenDuplicatesScans(int thresholdBetweenDuplicatesScans)Sets the threshold between duplicate scans in milliseconds.
SetResultDisappearanceDelayMs #
void SetResultDisappearanceDelayMs(int resultDisappearanceDelayMs)Sets the delay (in milliseconds) after which a detected AR result is considered expired and removed.
SetShowDuplicatesLocation #
void SetShowDuplicatesLocation(bool enabled)Enables or disables showing duplicate barcode locations on the preview overlay.
SetBeepOnSuccessEnabled #
void SetBeepOnSuccessEnabled(bool enabled)Enables or disables the beep sound on successful barcode scanning.
SetVibrateOnSuccessEnabled #
void SetVibrateOnSuccessEnabled(bool enabled)Enables or disables the vibration on successful barcode scanning.
Region & overlay #
SetRegionOfInterest #
void SetRegionOfInterest(int left, int top, int width, int height)Sets the region of interest (ROI) for barcode scanning within the camera preview.
SetRegionOfInterestVisible #
void SetRegionOfInterestVisible(bool visible)Sets the visibility of the region of interest (ROI) overlay for barcode scanning.
SetBarkoderRoiCenterMark #
void SetBarkoderRoiCenterMark(BarkoderRoiCenterMark roiCenterMark)Sets the visual marker displayed at the center of the scanner's Region of Interest (ROI).
SetLocationLineColor #
void SetLocationLineColor(string hexColor)Sets the color of the line indicating the barcode location in the camera preview.
SetRoiLineColor #
void SetRoiLineColor(string hexColor)Sets the color of the line indicating the region of interest (ROI) in the camera preview.
SetRoiOverlayBackgroundColor #
void SetRoiOverlayBackgroundColor(string hexColor)Sets the background color of the region of interest (ROI) overlay in the camera preview.
SetScanningIndicatorAlwaysVisibleEnabled #
void SetScanningIndicatorAlwaysVisibleEnabled(bool enabled)Sets the scanning indicator to be always shown on the camera feed.
SetScanningIndicatorColor #
void SetScanningIndicatorColor(string hexColor)Sets the color of the lines outlining the scanning indicator for barcode scanning on the camera feed.
SetScanningIndicatorAnimationMode #
void SetScanningIndicatorAnimationMode(int animationMode)Sets the animation of the scanning indicator for barcode scanning on the camera feed.
AR mode #
SetBarkoderARMode #
void SetBarkoderARMode(BarkoderARMode arMode)Sets the AR mode used for barcode scanning visualization.
SetBarkoderARHeaderShowMode #
void SetBarkoderARHeaderShowMode(BarkoderARHeaderShowMode headerShowMode)Sets the condition under which the header text is shown above the barcode.
SetBarkoderARLocationType #
void SetBarkoderARLocationType(BarkoderARLocationType locationType)Sets the style of location overlays drawn around detected barcodes.
SetBarkoderARoverlayRefresh #
void SetBarkoderARoverlayRefresh(BarkoderAROverlayRefresh overlayRefresh)Sets the refresh mode for the AR overlay on the camera preview.
SetARContinueScanningOnLimit #
void SetARContinueScanningOnLimit(bool enabled)Sets whether scanning continues when the result limit is reached (only in .interactiveDisabled mode).
SetAREmitResultsAtSessionEndOnly #
void SetAREmitResultsAtSessionEndOnly(bool enabled)Sets whether results are emitted only at AR session end (or when the limit is reached).
SetARImageResultEnabled #
void SetARImageResultEnabled(bool enabled)Enables or disables the capturing and processing of image data when a barcode is selected for AR mode.
SetARBarcodeThumbnailOnResultEnabled #
void SetARBarcodeThumbnailOnResultEnabled(bool enabled)Enables or disables the capturing and processing of thumbnail data when a barcode is selected for AR mode.
SetARResultLimit #
void SetARResultLimit(int resultLimit)Sets the maximum number of results allowed in a single AR scanning session.
SetARDoubleTapToFreezeEnabled #
void SetARDoubleTapToFreezeEnabled(bool enabled)Enables or disables the ability to freeze/unfreeze scanning via double-tap gesture in AR mode.
SetARReturnOnlyMatchedResults #
void SetARReturnOnlyMatchedResults(bool enabled)Controls whether only matched results are returned. If false, all detected results are returned, while unmatched results have IsMatched set to false. This option only applies when the AR mode is MatchFilter and a match filter is active.
SetARDisplayOnlyMatchedResults #
void SetARDisplayOnlyMatchedResults(bool enabled)Controls whether only matched results are displayed. If false, all decoded results are displayed, including unmatched results. This option only applies when the AR mode is MatchFilter and a match filter is active.
SetARSelectedLocationLineColor #
void SetARSelectedLocationLineColor(string hexColor)Sets the color used for drawing the overlay around selected barcodes in AR mode.
SetARNonSelectedLocationLineColor #
void SetARNonSelectedLocationLineColor(string hexColor)Sets the color used for drawing the overlay around non selected barcodes in AR mode.
SetARSelectedHeaderTextColor #
void SetARSelectedHeaderTextColor(string hexColor)Sets the text color of the header when the barcode is in a selected state.
SetARNonSelectedHeaderTextColor #
void SetARNonSelectedHeaderTextColor(string hexColor)Sets the text color of the header when the barcode is in a non selected state.
SetARSelectedLocationLineWidth #
void SetARSelectedLocationLineWidth(double locationWidth)Sets the width used for drawing the overlay around selected barcodes in AR mode.
SetARNonSelectedLocationLineWidth #
void SetARNonSelectedLocationLineWidth(double locationWidth)Sets the width used for drawing the overlay around non selected barcodes in AR mode.
SetARLocationTransitionSpeed #
void SetARLocationTransitionSpeed(double transitionSpeed)Sets the speed at which barcode location overlays transition positions.
SetARHeaderHeight #
void SetARHeaderHeight(double headerHeight)Sets the height of the header text label shown above the barcode in AR mode.
SetARHeaderMaxTextHeight #
void SetARHeaderMaxTextHeight(double headerHeightMaxText)Sets the maximum text height used for rendering AR header text.
SetARHeaderMinTextHeight #
void SetARHeaderMinTextHeight(double headerHeightMinText)Sets the minimum text height used for rendering AR header text.
SetARHeaderVerticalTextMargin #
void SetARHeaderVerticalTextMargin(double verticalTextMargin)Sets the vertical margin applied to the header text in AR mode, creating equal padding on both sides.
SetARHeaderHorizontalTextMargin #
void SetARHeaderHorizontalTextMargin(double horizontalTextMargin)Sets the horizontal margin applied to the header text in AR mode, creating equal padding on both sides.
SetARHeaderTextFormat #
void SetARHeaderTextFormat(string headerTextFormat)Sets the format string for the AR header text above each barcode.
SetHeaderTextFormatAR #
void SetHeaderTextFormatAR(string headerTextformat)Same effect as SetARHeaderTextFormat.
On-screen buttons #
ConfigureCloseButton #
void ConfigureCloseButton(bool visible, float[] position, float iconSize, string? tintColor, string? backgroundColor, float cornerRadius, float padding, bool useCustomIcon, string customIconBase64, Action? onClose)Configures the Close button used while scanning.
ConfigureFlashButton #
void ConfigureFlashButton(bool visible, float[] position, float iconSize, string? tintColor, string? backgroundColor, float cornerRadius, float padding, bool useCustomIcon, string? customIconFlashOnBase64, string? customIconFlashOffBase64)Configures the Flash (torch) button used while scanning, including position, size, styling and custom icons.
ConfigureZoomButton #
void ConfigureZoomButton(bool visible, float[] position, float iconSize, string? tintColor, string? backgroundColor, float cornerRadius, float padding, bool useCustomIcon, string? customIconZoomedInBase64, string? customIconZoomedOutBase64, float zoomedInFactor, float zoomedOutFactor)Configures the Zoom toggle button used while scanning, including position, size, styling, custom icons and zoom factors.
BarkoderView properties #
Bindable properties of BarkoderView (Plugin.Maui.Barkoder.Controls) for reading the current state, for example BKDView.Version. Change the settings with the methods above.
| Member | Declaration | Description |
|---|---|---|
Version | string { get; set; } | Retrieves the version of the Barkoder SDK (the plugin's version). |
LibVersion | string { get; set; } | Retrieves the version of the Barkoder library. |
DeviceId | string { get; set; } | Retrieves the Device ID. |
LicenseKey | string { get; set; } | Your license key; set it in XAML with barkoder:LicenseKey="...". |
RegionOfInterestVisible | bool { get; set; } | Whether the region of interest (ROI) is visible. Set it with SetRegionOfInterestVisible. |
IsFlashAvailable | bool { get; set; } | Checks whether the device has a flash (torch) for illumination during barcode scanning. |
MaxZoomFactor | double { get; set; } | Retrieves the maximum available zoom factor for the device's camera. |
LocationLineColorHex | string { get; set; } | The hexadecimal color code of the lines that show the location of detected barcodes. Set it with SetLocationLineColor. |
RoiLineColorHex | string { get; set; } | The hexadecimal color code of the Region of Interest (ROI) lines on the camera preview. Set it with SetRoiLineColor. |
RoiOverlayBackgroundColorHex | string { get; set; } | The hexadecimal color code of the overlay outside the Region of Interest (ROI). Set it with SetRoiOverlayBackgroundColor. |
EncodingCharacterSet | string { get; set; } | The character set used for encoding barcode data. Set it with SetEncodingCharacterSet. |
ARHeaderTextFormat | string { get; set; } | The value SetARHeaderTextFormat sets. |
LocationLineWidth | double { get; set; } | The width of the lines that show the location of detected barcodes on the camera feed. |
ARSelectedLocationLineWidth | double { get; set; } | The value SetARSelectedLocationLineWidth sets. |
ARNonSelectedLocationLineWidth | double { get; set; } | The value SetARNonSelectedLocationLineWidth sets. |
ARLocationTransitionSpeed | double { get; set; } | The value SetARLocationTransitionSpeed sets. |
RoiLineWidth | double { get; set; } | The width of the lines outlining the Region of Interest (ROI) on the camera preview. |
ImageResultEnabled | bool { get; set; } | Whether image result is enabled. Set it with SetImageResultEnabled. |
ARImageResultEnabled | bool { get; set; } | The value SetARImageResultEnabled sets. |
LocationInImageResultEnabled | bool { get; set; } | Whether location in image result is enabled. Set it with SetLocationInImageResultEnabled. |
LocationInPreviewEnabled | bool { get; set; } | Checks if location in preview is enabled. Set it with SetLocationInPreviewEnabled. |
PinchToZoomEnabled | bool { get; set; } | Whether pinch to zoom is enabled. Set it with SetPinchToZoomEnabled. |
BeepOnSuccessEnabled | bool { get; set; } | Whether a beep sound is played on successful barcode scanning. Set it with SetBeepOnSuccessEnabled. |
VibrateOnSuccessEnabled | bool { get; set; } | Whether vibration is enabled on successful barcode scanning. Set it with SetVibrateOnSuccessEnabled. |
CloseSessionOnResultEnabled | bool { get; set; } | Whether the session is closed upon detecting a result during barcode scanning. Set it with SetCloseSessionOnResultEnabled. |
BarkoderResolution | BarkoderResolution { get; set; } | The resolution for barcode scanning. Set it with SetBarkoderResolution. |
DecodingSpeed | DecodingSpeed { get; set; } | The decoding speed for barcode scanning. Set it with SetDecodingSpeed. |
FormattingType | FormattingType { get; set; } | The formatting type used for presenting decoded barcode data. Set it with SetFormattingType. |
MsiChecksumType | MsiChecksumType { get; set; } | The MSI checksum type. Set it with SetMsiChecksumType. |
Code11ChecksumType | Code11ChecksumType { get; set; } | The Code 11 checksum type. Set it with SetCode11ChecksumType. |
Code39ChecksumType | Code39ChecksumType { get; set; } | The Code 39 checksum type. Set it with SetCode39ChecksumType. |
ARContinueScanningOnLimit | bool { get; set; } | The value SetARContinueScanningOnLimit sets. |
AREmitResultsAtSessionEndOnly | bool { get; set; } | The value SetAREmitResultsAtSessionEndOnly sets. |
DatamatrixDpmModeEnabled | bool { get; set; } | Whether Direct Part Marking (DPM) mode is enabled for Datamatrix barcodes. Set it with SetDatamatrixDpmModeEnabled. |
IsIdDocumentMasterChecksumEnabled | bool { get; set; } | The value SetIdDocumentMasterChecksumEnabled sets. |
IsDatamatrixDpmModeEnabled | bool { get; set; } | The value SetDatamatrixDpmModeEnabled sets. |
UpcEanDeblurEnabled | bool { get; set; } | Whether deblurring is enabled for UPC/EAN barcodes. Set it with SetUpcEanDeblurEnabled. |
BarcodeThumbnailOnResultEnabled | bool { get; set; } | Checks if the barcode thumbnail on result is enabled. Set it with SetBarcodeThumbnailOnResultEnabled. |
ARBarcodeThumbnailOnResultEnabled | bool { get; set; } | The value SetARBarcodeThumbnailOnResultEnabled sets. |
MaximumResultsCount | int { get; set; } | Retrieves the maximum number of results to be returned from barcode scanning at once. Set it with SetMaximumResultsCount. |
ARResultLimit | int { get; set; } | The value SetARResultLimit sets. |
ARHeaderHeight | double { get; set; } | The value SetARHeaderHeight sets. |
ARHeaderMaxTextHeight | double { get; set; } | The value SetARHeaderMaxTextHeight sets. |
ARHeaderMinTextHeight | double { get; set; } | The value SetARHeaderMinTextHeight sets. |
VINRestrictionsEnabled | bool { get; set; } | Checks if VIN restrictions are enabled. Set it with SetEnableVINRestrictions. |
ARDoubleTapToFreezeEnabled | bool { get; set; } | The value SetARDoubleTapToFreezeEnabled sets. |
ARReturnOnlyMatchedResults | bool { get; set; } | The value SetARReturnOnlyMatchedResults sets. |
ARDisplayOnlyMatchedResults | bool { get; set; } | The value SetARDisplayOnlyMatchedResults sets. |
ThresholdBetweenDuplicatesScans | int { get; set; } | Retrieves the threshold between duplicate scans. Set it with SetThresholdBetweenDuplicatesScans. |
PowerSavingMode | int { get; set; } | The value SetPowerSavingMode sets. |
RegionOfInterest | (int, int, int, int) { get; set; } | The region of interest (ROI). Set it with SetRegionOfInterest. |
Settings models #
Barkoder.BarkoderConfig #
class
| Member | Type |
|---|---|
locationLineColor | long |
locationLineWidth | int |
roiLineColor | long |
roiLineWidth | int |
roiOverlayBackgroundColor | long |
closeSessionOnResultEnabled | bool |
imageResultEnabled | bool |
locationInImageResultEnabled | bool |
locationInPreviewEnabled | bool |
pinchToZoomEnabled | bool |
regionOfInterestVisible | bool |
beepOnSuccessEnabled | bool |
vibrateOnSuccessEnabled | bool |
decoder | DekoderConfig |
Barkoder.GeneralSettings #
class
| Member | JSON name | Type |
|---|---|---|
ThreadsLimit | maxThreads | int |
DecodingSpeed | decodingSpeed | DecodingSpeed |
RoiX | roi_x | int |
RoiY | roi_y | int |
RoiWidth | roi_w | int |
RoiHeight | roi_h | int |
RoiCenterMark | roiCenterMark | BarkoderRoiCenterMark |
FormattingType | formattingType | FormattingType |
EncodingCharacterSet | encodingCharacterSet | string |
UpcEanDeblur | upcEanDeblur | bool |
EnableMisshaped1D | enableMisshaped1D | bool |
Barkoder.BarcodeConfig and subclasses #
| Class | Extends | Members |
|---|---|---|
BarcodeConfig | bool enabled | |
BarcodeConfigWithLength | BarcodeConfig | int minLength, int maxLength |
Code39BarcodeConfig | BarcodeConfigWithLength | Code39ChecksumType checksum |
Code11BarcodeConfig | BarcodeConfigWithLength | Code11ChecksumType checksum |
MSIBarcodeConfig | BarcodeConfigWithLength | MsiChecksumType checksum |
DatamatrixBarcodeConfig | BarcodeConfigWithLength | int? dpmMode (a constructor parameter only) |
Constructors take (bool? enabled, int? minLength, int? maxLenght, ...); the maxLenght parameter name is misspelled in the source.
Barkoder.DekoderConfig #
class
| Member | JSON name | Type |
|---|---|---|
aztec | Aztec | BarcodeConfig |
aztecCompact | Aztec Compact | BarcodeConfig |
qr | QR | DatamatrixBarcodeConfig |
qrMicro | QR Micro | DatamatrixBarcodeConfig |
code128 | Code 128 | BarcodeConfigWithLength |
code93 | Code 93 | BarcodeConfigWithLength |
code39 | Code 39 | Code39BarcodeConfig |
codabar | Codabar | BarcodeConfigWithLength |
code11 | Code 11 | Code11BarcodeConfig |
msi | MSI | MSIBarcodeConfig |
upcA | Upc-A | BarcodeConfig |
upcE | Upc-E | BarcodeConfig |
upcE1 | Upc-E1 | BarcodeConfig |
ean13 | Ean-13 | BarcodeConfig |
ean8 | Ean-8 | BarcodeConfig |
pdf417 | PDF 417 | BarcodeConfig |
pdf417Micro | PDF 417 Micro | BarcodeConfig |
datamatrix | Datamatrix | DatamatrixBarcodeConfig |
code25 | Code 25 | BarcodeConfig |
interleaved25 | Interleaved 2 of 5 | BarcodeConfig |
itf14 | ITF 14 | BarcodeConfig |
iata25 | IATA 25 | BarcodeConfig |
matrix25 | Matrix 25 | BarcodeConfig |
datalogic25 | Datalogic 25 | BarcodeConfig |
coop25 | COOP 25 | BarcodeConfig |
code32 | Code 32 | BarcodeConfig |
telepen | Telepen | BarcodeConfig |
dotcode | Dotcode | BarcodeConfig |
idDocument | ID Document | BarcodeConfig |
databar14 | Databar 14 | BarcodeConfig |
databarLimited | Databar Limited | BarcodeConfig |
databarExpanded | Databar Expanded | BarcodeConfig |
postalIMB | Postal IMB | BarcodeConfig |
postnet | Postnet | BarcodeConfig |
planet | Planet | BarcodeConfig |
australianPost | Australian Post | BarcodeConfig |
royalMail | Royal Mail | BarcodeConfig |
kix | KIX | BarcodeConfig |
japanesePost | Japanese Post | BarcodeConfig |
maxicode | MaxiCode | BarcodeConfig |
ocrText | OCR Text | BarcodeConfig |
general | general | GeneralSettings |
Result models #
Plugin.Maui.Barkoder.Controls.BarcodeTypeEventArgs #
class, extends EventArgs
| Member | Kind | Declaration |
|---|---|---|
BarcodeTypeEventArgs | constructor | BarcodeTypeEventArgs(BarcodeType barcodeType, bool enabled) |
BarcodeType | property | BarcodeType { get; } |
Enabled | property | bool { get; } |
Plugin.Maui.Barkoder.Controls.BarcodeRangeEventArg #
class, extends EventArgs
| Member | Kind | Declaration |
|---|---|---|
BarcodeRangeEventArg | constructor | BarcodeRangeEventArg(BarcodeType barcodeType, int min, int max) |
BarcodeType | property | BarcodeType { get; } |
Min | property | int { get; } |
Max | property | int { get; } |
Plugin.Maui.Barkoder.Interfaces.IBarkoderDelegate #
interface. Both methods have default (empty / forwarding) implementations, so implement the one you need.
| Member | Kind | Declaration |
|---|---|---|
DidFinishScanning | method | void DidFinishScanning(BarcodeResult[] result, ImageSource originalImageSource) |
DidFinishScanning | method | void DidFinishScanning(BarcodeResult[] result, ImageSource[] thumbnails, ImageSource originalImageSource) |
Call default interface members through the interface type, or implement the method explicitly on your class.
Plugin.Maui.Barkoder.Handlers.BarcodeResult #
class
| Member | Kind | Declaration |
|---|---|---|
BarcodeResult | constructor | BarcodeResult(string textualData, string barcodeTypeName, Dictionary<string, object>? extra, string characterSet, List<ImageData> mrzImages, BarcodeLocation location, string binaryDataAsBase64, string sadlImageAsBase64, bool isMatched = false) |
TextualData | property | string { get; set; } |
BarcodeTypeName | property | string { get; set; } |
Extra | property | Dictionary<string, object>? { get; set; } |
CharacterSet | property | string { get; set; } |
MrzImages | property | List<ImageData> { get; set; } |
Location | property | BarcodeLocation { get; set; } |
BinaryDataAsBase64 | property | string { get; set; } |
SadlImageAsBase64 | property | string { get; set; } |
IsMatched | property | bool { get; set; } |
Plugin.Maui.Barkoder.Handlers.ImageData #
class
| Member | Kind | Declaration |
|---|---|---|
ImageData | constructor | ImageData(string name, ImageSource image) |
Name | property | string { get; set; } |
Image | property | ImageSource { get; set; } |
Plugin.Maui.Barkoder.Handlers.BarcodeLocation #
class
| Member | Kind | Declaration |
|---|---|---|
Points | property | List<BarcodePoint> { get; set; } |
LocationName | property | string { get; set; } |
Plugin.Maui.Barkoder.Handlers.BarcodePoint #
class
| Member | Kind | Declaration |
|---|---|---|
BarcodePoint | constructor | BarcodePoint(float x, float y) |
X | property | float { get; set; } |
Y | property | float { get; set; } |
Plugin.Maui.Barkoder.Common.BarkoderGlobal #
static partial class
| Member | Kind | Declaration |
|---|---|---|
SetCustomOptionGlobal | method | static void SetCustomOptionGlobal(string option, int value) |
Plugin.Maui.Barkoder.Controls.BarkoderViewHandler #
partial class, extends ViewHandler<BarkoderView, ...> (per-platform native view). MAUI infrastructure; app code does not call it directly except through BarkoderView.
| Member | Kind | Declaration |
|---|---|---|
BarkoderViewHandler | constructor | BarkoderViewHandler() |
PropertyMapper | property | static IPropertyMapper<BarkoderView, BarkoderViewHandler> |
CommandMapper | property | static CommandMapper<BarkoderView, BarkoderViewHandler> |
GetCurrentZoomFactor | method | float GetCurrentZoomFactor() |
GetAvailableCameras | method | List<Dictionary<string, string>> GetAvailableCameras() |
Enums #
BarcodeType #
| Value | = |
|---|---|
Aztec | 0 |
AztecCompact | 1 |
QR | 2 |
QRMicro | 3 |
Code128 | 4 |
Code93 | 5 |
Code39 | 6 |
Codabar | 7 |
Code11 | 8 |
Msi | 9 |
UpcA | 10 |
UpcE | 11 |
UpcE1 | 12 |
Ean13 | 13 |
Ean8 | 14 |
PDF417 | 15 |
PDF417Micro | 16 |
Datamatrix | 17 |
Code25 | 18 |
Interleaved25 | 19 |
Itf14 | 20 |
Uata25 | 21 |
Matrix25 | 22 |
Datalogic25 | 23 |
Coop25 | 24 |
Code32 | 25 |
Telepen | 26 |
Dotcode | 27 |
IDDocument | 28 |
Databar14 | 29 |
DatabarLimited | 30 |
DatabarExpanded | 31 |
PostalIMB | 32 |
Postnet | 33 |
Planet | 34 |
AustralianPost | 35 |
RoyalMail | 36 |
KIX | 37 |
JapanesePost | 38 |
Maxicode | 39 |
OCRText | 40 |
Uata25 is the spelling in the source (the NativeScript plugin calls it IATA25).
DecoderType #
Same 41 values, same order and integers as BarcodeType. BarkoderView methods take BarcodeType; DecoderType is not referenced by any BarkoderView member.
BarkoderResolution #
| Value | = |
|---|---|
HD | 0 |
FHD | 1 |
UHD | 2 |
BarkoderARMode #
| Value | = |
|---|---|
OFF | 0 |
InteractiveDisabled | 1 |
InteractiveEnabled | 2 |
NonInteractive | 3 |
MatchFilter | 4 |
BarkoderARHeaderShowMode #
| Value | = |
|---|---|
NEVER | 0 |
ALWAYS | 1 |
ONSELECTED | 2 |
BarkoderARLocationType #
| Value | = |
|---|---|
NONE | 0 |
TIGHT | 1 |
BOUNDINGBOX | 2 |
BarkoderAROverlayRefresh #
| Value | = |
|---|---|
SMOOTH | 0 |
NORMAL | 1 |
BarkoderCameraPosition #
| Value | = |
|---|---|
BACK | 0 |
FRONT | 1 |
BarkoderRoiCenterMark #
| Value | = |
|---|---|
NONE | 0 |
POINT | 1 |
CROSSHAIR | 2 |
The NativeScript plugin orders these NONE, CROSSHAIR, POINT; the integers differ.
DecodingSpeed #
| Value | = |
|---|---|
Fast | 0 |
Normal | 1 |
Slow | 2 |
Rigorous | 3 |
FormattingType #
| Value | = |
|---|---|
Disabled | 0 |
Automatic | 1 |
GS1 | 2 |
AAMVA | 3 |
SADL | 4 |
BCBP | 5 |
Code11ChecksumType #
| Value | = |
|---|---|
Disabled | 0 |
Single | 1 |
Double | 2 |
Code39ChecksumType #
| Value | = |
|---|---|
Disabled | 0 |
Enabled | 1 |
MsiChecksumType #
| Value | = |
|---|---|
Disabled | 0 |
Mod10 | 1 |
Mod11 | 2 |
Mod1010 | 3 |
Mod1110 | 4 |
Mod11IBM | 5 |
Mod1110IBM | 6 |