This is a guide for the Capacitor plugin powered by the barKoder Barcode Scanner SDK.
Capacitor is a cross-platform app runtime that makes it easy to build web apps that run natively on iOS, Android and the web. To get started with building apps using Capacitor, you'll need to meet certain requirements:
npm install -g @capacitor/cli
npx cap add ios
npx cap add android
npx cap open ios
npx cap open android
These steps provide a basic overview, and the Capacitor documentation may have been updated since our last knowledge update. It's always a good idea to refer to the official Capacitor documentation for the latest and most accurate information: Capacitor Documentation.
npm install barkoder-capacitor
npx cap sync
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(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(options: { licenseKey: string; }) => Promise<any>
Param | Type |
---|---|
options |
{ licenseKey: string; } |
Returns: Promise<any>
setZoomFactor(options: { value: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: number; } |
Returns: Promise<any>
setFlashEnabled(options: { enabled: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ enabled: boolean; } |
Returns: Promise<any>
startCamera() => Promise<any>
Returns: Promise<any>
startScanning() => Promise<any>
Returns: Promise<any>
stopScanning() => Promise<any>
Returns: Promise<any>
pauseScanning() => Promise<any>
Returns: Promise<any>
setLocationLineColor(options: { value: string; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: string; } |
Returns: Promise<any>
setLocationLineWidth(options: { value: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: number; } |
Returns: Promise<any>
setRoiLineColor(options: { value: string; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: string; } |
Returns: Promise<any>
setRoiLineWidth(options: { value: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: number; } |
Returns: Promise<any>
setRoiOverlayBackgroundColor(options: { value: string; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: string; } |
Returns: Promise<any>
setCloseSessionOnResultEnabled(options: { enabled: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ enabled: boolean; } |
Returns: Promise<any>
setImageResultEnabled(options: { enabled: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ enabled: boolean; } |
Returns: Promise<any>
setLocationInImageResultEnabled(options: { enabled: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ enabled: boolean; } |
Returns: Promise<any>
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(options: { value: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: number; } |
Returns: Promise<any>
setLocationInPreviewEnabled(options: { enabled: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ enabled: boolean; } |
Returns: Promise<any>
setPinchToZoomEnabled(options: { enabled: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ enabled: boolean; } |
Returns: Promise<any>
setRegionOfInterestVisible(options: { value: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: boolean; } |
Returns: Promise<any>
setBarkoderResolution(options: { value: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: number; } |
Returns: Promise<any>
setBeepOnSuccessEnabled(options: { enabled: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ enabled: boolean; } |
Returns: Promise<any>
setVibrateOnSuccessEnabled(options: { enabled: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ enabled: boolean; } |
Returns: Promise<any>
showLogMessages(options: { enabled: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ enabled: boolean; } |
Returns: Promise<any>
setBarcodeTypeLengthRange(options: { type: number; min: number; max: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ type: number; min: number; max: number; } |
Returns: Promise<any>
setEncodingCharacterSet(options: { value: string; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: string; } |
Returns: Promise<any>
setDecodingSpeed(options: { value: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: number; } |
Returns: Promise<any>
setFormattingType(options: { value: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: number; } |
Returns: Promise<any>
setCode11ChecksumType(options: { value: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: number; } |
Returns: Promise<any>
setMsiChecksumType(options: { value: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: number; } |
Returns: Promise<any>
setCode39ChecksumType(options: { value: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: number; } |
Returns: Promise<any>
setBarcodeTypeEnabled(options: { type: number; enabled: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ type: number; enabled: boolean; } |
Returns: Promise<any>
setMulticodeCachingEnabled(options: { enabled: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ enabled: boolean; } |
Returns: Promise<any>
setMulticodeCachingDuration(options: { value: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: number; } |
Returns: Promise<any>
setMaximumResultsCount(options: { value: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: number; } |
Returns: Promise<any>
setBarcodeThumbnailOnResultEnabled(options: { enabled: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ enabled: boolean; } |
Returns: Promise<any>
setDuplicatesDelayMs(options: { value: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: number; } |
Returns: Promise<any>
setThresholdBetweenDuplicatesScans(options: { value: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: number; } |
Returns: Promise<any>
setUpcEanDeblurEnabled(options: { enabled: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ enabled: boolean; } |
Returns: Promise<any>
setMisshaped1DEnabled(options: { enabled: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ enabled: boolean; } |
Returns: Promise<any>
setEnableVINRestrictions(options: { value: boolean; }) => Promise<any>
Param | Type |
---|---|
options |
{ value: boolean; } |
Returns: Promise<any>
isFlashAvailable() => Promise<any>
Returns: Promise<any>
isCloseSessionOnResultEnabled() => Promise<any>
Returns: Promise<any>
isImageResultEnabled() => Promise<any>
Returns: Promise<any>
isLocationInImageResultEnabled() => Promise<any>
Returns: Promise<any>
isLocationInPreviewEnabled() => Promise<any>
Returns: Promise<any>
isPinchToZoomEnabled() => Promise<any>
Returns: Promise<any>
isRegionOfInterestVisible() => Promise<any>
Returns: Promise<any>
isBeepOnSuccessEnabled() => Promise<any>
Returns: Promise<any>
isVibrateOnSuccessEnabled() => Promise<any>
Returns: Promise<any>
getVersion() => Promise<any>
Returns: Promise<any>
getLocationLineColorHex() => Promise<any>
Returns: Promise<any>
getRoiLineColorHex() => Promise<any>
Returns: Promise<any>
getRoiOverlayBackgroundColorHex() => Promise<any>
Returns: Promise<any>
getMaxZoomFactor() => Promise<any>
Returns: Promise<any>
getLocationLineWidth() => Promise<any>
Returns: Promise<any>
getRoiLineWidth() => Promise<any>
Returns: Promise<any>
getRegionOfInterest() => Promise<any>
Returns: Promise<any>
getBarcodeTypeLengthRange(options: { type: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ type: number; } |
Returns: Promise<any>
getMsiChecksumType() => Promise<any>
Returns: Promise<any>
getCode39ChecksumType() => Promise<any>
Returns: Promise<any>
getCode11ChecksumType() => Promise<any>
Returns: Promise<any>
getEncodingCharacterSet() => Promise<any>
Returns: Promise<any>
getDecodingSpeed() => Promise<any>
Returns: Promise<any>
getFormattingType() => Promise<any>
Returns: Promise<any>
getThreadsLimit() => Promise<any>
Returns: Promise<any>
getMaximumResultsCount() => Promise<any>
Returns: Promise<any>
getDuplicatesDelayMs() => Promise<any>
Returns: Promise<any>
isBarcodeTypeEnabled(options: { type: number; }) => Promise<any>
Param | Type |
---|---|
options |
{ type: number; } |
Returns: Promise<any>
getMulticodeCachingEnabled() => Promise<any>
Returns: Promise<any>
getMulticodeCachingDuration() => Promise<any>
Returns: Promise<any>
isUpcEanDeblurEnabled() => Promise<any>
Returns: Promise<any>
isMisshaped1DEnabled() => Promise<any>
Returns: Promise<any>
isBarcodeThumbnailOnResultEnabled() => Promise<any>
Returns: Promise<any>
getThresholdBetweenDuplicatesScans() => Promise<any>
Returns: Promise<any>
isVINRestrictionsEnabled() => Promise<any>
Returns: Promise<any>
Your content here