barkoder-capacitor

barkoder-capacitor

Capacitor plugin that connects to barkoderSDK which helps users scan barcodes with mobile devices

Install

npm install barkoder-capacitor
npx cap sync

API

• initialize(...)
• registerWithLicenseKey(...)
• setZoomFactor(...)
• setFlashEnabled(...)
• startCamera()
• startScanning()
• stopScanning()
• pauseScanning()
• setLocationLineColor(...)
• setLocationLineWidth(...)
• setRoiLineColor(...)
• setRoiLineWidth(...)
• setRoiOverlayBackgroundColor(...)
• setCloseSessionOnResultEnabled(...)
• setImageResultEnabled(...)
• setLocationInImageResultEnabled(...)
• setRegionOfInterest(...)
• setThreadsLimit(...)
• setLocationInPreviewEnabled(...)
• setPinchToZoomEnabled(...)
• setRegionOfInterestVisible(...)
• setBarkoderResolution(...)
• setBeepOnSuccessEnabled(...)
• setVibrateOnSuccessEnabled(...)
• showLogMessages(...)
• setBarcodeTypeLengthRange(...)
• setEncodingCharacterSet(...)
• setDecodingSpeed(...)
• setFormattingType(...)
• setCode11ChecksumType(...)
• setMsiChecksumType(...)
• setCode39ChecksumType(...)
• setBarcodeTypeEnabled(...)
• setMulticodeCachingEnabled(...)
• setMulticodeCachingDuration(...)
• setMaximumResultsCount(...)
• setBarcodeThumbnailOnResultEnabled(...)
• setDuplicatesDelayMs(...)
• setThresholdBetweenDuplicatesScans(...)
• setUpcEanDeblurEnabled(...)
• setMisshaped1DEnabled(...)
• setEnableVINRestrictions(...)
• isFlashAvailable()
• isCloseSessionOnResultEnabled()
• isImageResultEnabled()
• isLocationInImageResultEnabled()
• isLocationInPreviewEnabled()
• isPinchToZoomEnabled()
• isRegionOfInterestVisible()
• isBeepOnSuccessEnabled()
• isVibrateOnSuccessEnabled()
• getVersion()
• getLocationLineColorHex()
• getRoiLineColorHex()
• getRoiOverlayBackgroundColorHex()
• getMaxZoomFactor()
• getLocationLineWidth()
• getRoiLineWidth()
• getRegionOfInterest()
• getBarcodeTypeLengthRange(...)
• getMsiChecksumType()
• getCode39ChecksumType()
• getCode11ChecksumType()
• getEncodingCharacterSet()
• getDecodingSpeed()
• getFormattingType()
• getThreadsLimit()
• getMaximumResultsCount()
• getDuplicatesDelayMs()
• isBarcodeTypeEnabled(...)
• getMulticodeCachingEnabled()
• getMulticodeCachingDuration()
• isUpcEanDeblurEnabled()
• isMisshaped1DEnabled()
• isBarcodeThumbnailOnResultEnabled()
• getThresholdBetweenDuplicatesScans()
• isVINRestrictionsEnabled()

initialize(...)

initialize(options: { width: number; height: number; x: number; y: number; }) => Promise<any>

Param	Type
options	{ width: number; height: number; x: number; y: number; }

Returns: Promise<any>

---

registerWithLicenseKey(...)

registerWithLicenseKey(options: { licenseKey: string; }) => Promise<any>

Param	Type
options	{ licenseKey: string; }

Returns: Promise<any>

---

setZoomFactor(...)

setZoomFactor(options: { value: number; }) => Promise<any>

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setFlashEnabled(...)

setFlashEnabled(options: { enabled: boolean; }) => Promise<any>

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

startCamera()

startCamera() => Promise<any>

Returns: Promise<any>

---

startScanning()

startScanning() => Promise<any>

Returns: Promise<any>

---

stopScanning()

stopScanning() => Promise<any>

Returns: Promise<any>

---

pauseScanning()

pauseScanning() => Promise<any>

Returns: Promise<any>

---

setLocationLineColor(...)

setLocationLineColor(options: { value: string; }) => Promise<any>

Param	Type
options	{ value: string; }

Returns: Promise<any>

---

setLocationLineWidth(...)

setLocationLineWidth(options: { value: number; }) => Promise<any>

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setRoiLineColor(...)

setRoiLineColor(options: { value: string; }) => Promise<any>

Param	Type
options	{ value: string; }

Returns: Promise<any>

---

setRoiLineWidth(...)

setRoiLineWidth(options: { value: number; }) => Promise<any>

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setRoiOverlayBackgroundColor(...)

setRoiOverlayBackgroundColor(options: { value: string; }) => Promise<any>

Param	Type
options	{ value: string; }

Returns: Promise<any>

---

setCloseSessionOnResultEnabled(...)

setCloseSessionOnResultEnabled(options: { enabled: boolean; }) => Promise<any>

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setImageResultEnabled(...)

setImageResultEnabled(options: { enabled: boolean; }) => Promise<any>

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setLocationInImageResultEnabled(...)

setLocationInImageResultEnabled(options: { enabled: boolean; }) => Promise<any>

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setRegionOfInterest(...)

setRegionOfInterest(options: { left: number; top: number; width: number; height: number; }) => Promise<any>

Param	Type
options	{ left: number; top: number; width: number; height: number; }

Returns: Promise<any>

---

setThreadsLimit(...)

setThreadsLimit(options: { value: number; }) => Promise<any>

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setLocationInPreviewEnabled(...)

setLocationInPreviewEnabled(options: { enabled: boolean; }) => Promise<any>

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setPinchToZoomEnabled(...)

setPinchToZoomEnabled(options: { enabled: boolean; }) => Promise<any>

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setRegionOfInterestVisible(...)

setRegionOfInterestVisible(options: { value: boolean; }) => Promise<any>

Param	Type
options	{ value: boolean; }

Returns: Promise<any>

---

setBarkoderResolution(...)

setBarkoderResolution(options: { value: number; }) => Promise<any>

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setBeepOnSuccessEnabled(...)

setBeepOnSuccessEnabled(options: { enabled: boolean; }) => Promise<any>

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setVibrateOnSuccessEnabled(...)

setVibrateOnSuccessEnabled(options: { enabled: boolean; }) => Promise<any>

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

showLogMessages(...)

showLogMessages(options: { enabled: boolean; }) => Promise<any>

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setBarcodeTypeLengthRange(...)

setBarcodeTypeLengthRange(options: { type: number; min: number; max: number; }) => Promise<any>

Param	Type
options	{ type: number; min: number; max: number; }

Returns: Promise<any>

---

setEncodingCharacterSet(...)

setEncodingCharacterSet(options: { value: string; }) => Promise<any>

Param	Type
options	{ value: string; }

Returns: Promise<any>

---

setDecodingSpeed(...)

setDecodingSpeed(options: { value: number; }) => Promise<any>

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setFormattingType(...)

setFormattingType(options: { value: number; }) => Promise<any>

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setCode11ChecksumType(...)

setCode11ChecksumType(options: { value: number; }) => Promise<any>

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setMsiChecksumType(...)

setMsiChecksumType(options: { value: number; }) => Promise<any>

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setCode39ChecksumType(...)

setCode39ChecksumType(options: { value: number; }) => Promise<any>

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setBarcodeTypeEnabled(...)

setBarcodeTypeEnabled(options: { type: number; enabled: boolean; }) => Promise<any>

Param	Type
options	{ type: number; enabled: boolean; }

Returns: Promise<any>

---

setMulticodeCachingEnabled(...)

setMulticodeCachingEnabled(options: { enabled: boolean; }) => Promise<any>

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setMulticodeCachingDuration(...)

setMulticodeCachingDuration(options: { value: number; }) => Promise<any>

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setMaximumResultsCount(...)

setMaximumResultsCount(options: { value: number; }) => Promise<any>

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setBarcodeThumbnailOnResultEnabled(...)

setBarcodeThumbnailOnResultEnabled(options: { enabled: boolean; }) => Promise<any>

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setDuplicatesDelayMs(...)

setDuplicatesDelayMs(options: { value: number; }) => Promise<any>

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setThresholdBetweenDuplicatesScans(...)

setThresholdBetweenDuplicatesScans(options: { value: number; }) => Promise<any>

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

setUpcEanDeblurEnabled(...)

setUpcEanDeblurEnabled(options: { enabled: boolean; }) => Promise<any>

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setMisshaped1DEnabled(...)

setMisshaped1DEnabled(options: { enabled: boolean; }) => Promise<any>

Param	Type
options	{ enabled: boolean; }

Returns: Promise<any>

---

setEnableVINRestrictions(...)

setEnableVINRestrictions(options: { value: boolean; }) => Promise<any>

Param	Type
options	{ value: boolean; }

Returns: Promise<any>

---

isFlashAvailable()

isFlashAvailable() => Promise<any>

Returns: Promise<any>

---

isCloseSessionOnResultEnabled()

isCloseSessionOnResultEnabled() => Promise<any>

Returns: Promise<any>

---

isImageResultEnabled()

isImageResultEnabled() => Promise<any>

Returns: Promise<any>

---

isLocationInImageResultEnabled()

isLocationInImageResultEnabled() => Promise<any>

Returns: Promise<any>

---

isLocationInPreviewEnabled()

isLocationInPreviewEnabled() => Promise<any>

Returns: Promise<any>

---

isPinchToZoomEnabled()

isPinchToZoomEnabled() => Promise<any>

Returns: Promise<any>

---

isRegionOfInterestVisible()

isRegionOfInterestVisible() => Promise<any>

Returns: Promise<any>

---

isBeepOnSuccessEnabled()

isBeepOnSuccessEnabled() => Promise<any>

Returns: Promise<any>

---

isVibrateOnSuccessEnabled()

isVibrateOnSuccessEnabled() => Promise<any>

Returns: Promise<any>

---

getVersion()

getVersion() => Promise<any>

Returns: Promise<any>

---

getLocationLineColorHex()

getLocationLineColorHex() => Promise<any>

Returns: Promise<any>

---

getRoiLineColorHex()

getRoiLineColorHex() => Promise<any>

Returns: Promise<any>

---

getRoiOverlayBackgroundColorHex()

getRoiOverlayBackgroundColorHex() => Promise<any>

Returns: Promise<any>

---

getMaxZoomFactor()

getMaxZoomFactor() => Promise<any>

Returns: Promise<any>

---

getLocationLineWidth()

getLocationLineWidth() => Promise<any>

Returns: Promise<any>

---

getRoiLineWidth()

getRoiLineWidth() => Promise<any>

Returns: Promise<any>

---

getRegionOfInterest()

getRegionOfInterest() => Promise<any>

Returns: Promise<any>

---

getBarcodeTypeLengthRange(...)

getBarcodeTypeLengthRange(options: { type: number; }) => Promise<any>

Param	Type
options	{ type: number; }

Returns: Promise<any>

---

getMsiChecksumType()

getMsiChecksumType() => Promise<any>

Returns: Promise<any>

---

getCode39ChecksumType()

getCode39ChecksumType() => Promise<any>

Returns: Promise<any>

---

getCode11ChecksumType()

getCode11ChecksumType() => Promise<any>

Returns: Promise<any>

---

getEncodingCharacterSet()

getEncodingCharacterSet() => Promise<any>

Returns: Promise<any>

---

getDecodingSpeed()

getDecodingSpeed() => Promise<any>

Returns: Promise<any>

---

getFormattingType()

getFormattingType() => Promise<any>

Returns: Promise<any>

---

getThreadsLimit()

getThreadsLimit() => Promise<any>

Returns: Promise<any>

---

getMaximumResultsCount()

getMaximumResultsCount() => Promise<any>

Returns: Promise<any>

---

getDuplicatesDelayMs()

getDuplicatesDelayMs() => Promise<any>

Returns: Promise<any>

---

isBarcodeTypeEnabled(...)

isBarcodeTypeEnabled(options: { type: number; }) => Promise<any>

Param	Type
options	{ type: number; }

Returns: Promise<any>

---

getMulticodeCachingEnabled()

getMulticodeCachingEnabled() => Promise<any>

Returns: Promise<any>

---

getMulticodeCachingDuration()

getMulticodeCachingDuration() => Promise<any>

Returns: Promise<any>

---

isUpcEanDeblurEnabled()

isUpcEanDeblurEnabled() => Promise<any>

Returns: Promise<any>

---

isMisshaped1DEnabled()

isMisshaped1DEnabled() => Promise<any>

Returns: Promise<any>

---

isBarcodeThumbnailOnResultEnabled()

isBarcodeThumbnailOnResultEnabled() => Promise<any>

Returns: Promise<any>

---

getThresholdBetweenDuplicatesScans()

getThresholdBetweenDuplicatesScans() => Promise<any>

Returns: Promise<any>

---

isVINRestrictionsEnabled()

isVINRestrictionsEnabled() => Promise<any>

Returns: Promise<any>

---