3.2.9 • Published 2 years ago

cordova-plugin-captureid v3.2.9

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

appcenterbanner

Apache Cordova Plugin for Cortex Decoder

This plugin provides the ability to use the Cortex Decoder Engine to easily build highly performant Barcode scanning app(s).

Requirements

The Cortex Decoder plugin requires a valid license key for the native Cortex Decoder Library. This license must be purchased separatly and is not included in this package. For additional Information of the Cortex Decoder Library and how to get access to a valid license Key visit our Website under (https://www.p4it.de/cortexdecoder).

Supported Cordova Platforms

Cordova 8.0.0+ is fully supported, along with the following asociated platforms:

To check which versions of each Cordova platform you are currently using, you can run the following command and inspect the Installed platforms list:

cordova platform ls

If you're running an older Android and/or iOS platform than is mentioned above, and would be open to upgrading, you can easily do so by running the following commands (omitting a platform if it isn't neccessary):

cordova platform update android

How does it work?

Getting Started

cordova plugin add cordova-plugin-cortex-decoder@latest
  1. Add your license keys to the app config.xml file:
<preference name="CortexLicenseKey" value="YOUR-CORTEX-LICENSE-KEY" />
  1. To ensure that your app is correctly licensed call the functions isLicenseActivated and isLicenseExpired at app start before calling any other function of the plugin.
cordova.plugins.cortexdecoder.isLicenseActivated(this.licenseActivatedSuccess.bind(this), this.error.bind(this), null);
cordova.plugins.cortexdecoder.isLicenseExpired(this.licenseExpiredSuccess.bind(this), this.error.bind(this), null);      

dependend on the callback result you will be required to call activateLicense function of the plugin.

cordova.plugins.cortexdecoder.activateLicense(this.licenseSuccess.bind(this), this.error.bind(this), "");

the third parameter of this function must be an empty string or a valid Cortex License Key. Keep in mind the security risc providing the key in javascript code. Providing the Key in this function call is required if the Cortex License Key is not included in your config.xml file.

  1. Now you can call call the Plugin functions like:
cordova.plugins.cortexdecoder.<FUNKTION-NAME>(<SUCCESS-CALLBACK>, <ERROR-CALLBACK>, <PARAMETERS>);

Plugin Usage

With the CortexDecoder plugin installed and configured, the only thing left is to add the necessary code to your app.

  1. Call the provided functions and add the callbacks.

  2. The callback parameter provides a JSON array with the following content:

  • FunctionName: name of the calling function.
  • error: error description in case of an error.
  • intValue: return value has to be interpreted as an integer.
  • stringValue: return value has to be interpreted as an string.
  • boolValue: return value has to be interpreted as an boolean.
  • longValue: return value has to be interpreted as an long.
  • floatValue: return value has to be interpreted as an float.
  • objValue: return value has to be interpreted as an object(ie. barcode object).

example:

in case of returning a single barcode the intValue contains 1 and the objValue contains the entries:

  • SymbologyType: the barcode type.
  • Data: the decoded data.
  • Length: length of the decoded data.

in case of returning multiple barcodes the inValue field contains the count of barcodes provided in by the objValue field. The objValue field contains an array of barcodes entries with the fields described above.

API Reference

Constants

Resolution

  • Resolution_1280x720 = "Resolution_1280x720";
  • Resolution_1920x1080 = "Resolution_1920x1080";
  • Resolution_352x288 = "Resolution_352x288";
  • Resolution_640x480 = "Resolution_640x480";

Camera Type

  • CameraType_BackFacing = "BackFacing";
  • CameraType_FrontFacing = "FrontFacing";

Focus

  • Focus_Far = "Focus_Far";
  • Focus_Fix_Far = "Focus_Fix_Far";
  • Focus_Fix_Normal = "Focus_Fix_Normal";
  • Focus_Normal = "Focus_Normal";

activateLicense

activateLicense(onSuccess, onError?, productKey?: String);

Version 1.0.0 Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • productKey (String) - (optional) a valid License Key.

startSplitScreen

startSplitScreen(onSuccess, onError?, height?: number, minHeight?: number, maxHeight?: number);

Version 1.0.0 Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • height (number) - Defines the height of the SplitScreen.

  • minHeight (number) - Defines the minimum height of the SplitScreen.

  • maxHeight (number) - Defines the maximum height of the SplitScreen.

startSplitOverlay

startSplitOverlay(onSuccess, onError?, height?: number, paddingTop?: number, minHeight?: number, maxHeight?: number);

Version 1.0.0 Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • height (number) - Defines the height of the SplitOverlay.

  • paddingTop (number) - Defines the padding to the top of your app.

  • minHeight (number) - Defines the minimum height of the SplitOverlay.

  • maxHeight (number) - Defines the maximum height of the SplitOverlay.

enableHUD

enableHUD(onSuccess, onError?, enable?: boolean);

Version 1.0.0 Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • enable (boolean) - Enables/disables the Zebra HD4000 HUD Interface.

captureCurrentImageInBuffer

captureCurrentImageInBuffer(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

changeBeepPlayerSound

changeBeepPlayerSound(onSuccess, onError?, name: String);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • name (String) the name of the sound to be played.

closeCamera

closeCamera(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

closeSharedObject

closeSharedObject(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

CRD_Set(onSuccess, onError?, property: String, value: any);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

currentSizeOfDecoderVideo

currentSizeOfDecoderVideo(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

decoderTimeLimitInMilliseconds

decoderTimeLimitInMilliseconds(onSuccess, onError?, milliseconds?: number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • milliseconds (Number) this should be a positive integer representing the timeout in milliseconds. If set to 0 no timeout will be used.

decoderVersion

decoderVersion(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

decoderVersionLevel

decoderVersionLevel(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

doDecode

doDecode(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • pixBuf (Array) an Image is converted to a byte buffer so that it can be used by the decoder to decode the barcode

  • width (Number) the width of the image
  • height (Number) the height of the image
  • stride (Number) the stride/width of the image

enableBeepPlayer

enableBeepPlayer(onSuccess, onError?, enable: Boolean);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • enable (Boolean) true to enable.

enableFixedExposureMode

enableFixedExposureMode(onSuccess, onError?, enabled: Boolean, exposureValue: number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • enabled (Boolean) If set to true, then fixed exposure mode is enabled.

  • exposureValue (Long) This should be a Long integer representing the new value for exposure compensation.

enableScannedImageCapture

enableScannedImageCapture(onSuccess, onError?, enable: Boolean);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • enable (Boolean) true to enable.

enableVibrateOnScan

enableVibrateOnScan(onSuccess, onError?, enable: Boolean);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • enable (Boolean) true to enable.

ensureRegionOfInterest

ensureRegionOfInterest(onSuccess, onError?, enable: Boolean);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • enable (Boolean) true to enable.

generateDeviceID

generateDeviceID(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

getCameraPreview

getCameraPreview(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

getDecodeVal

getDecodeVal(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

getExposureTime

getExposureTime(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

getFocusDistance

getFocusDistance(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

getLicensedSymbologies

getLicensedSymbologies(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

getMaxZoom

getMaxZoom(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

getSdkVersion

getSdkVersion(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

getSensitivityBoost

getSensitivityBoost(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

getSizeForROI

getSizeForROI(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

getSupportedCameraTypes

getSupportedCameraTypes(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

getSupportedFocusModes

getSupportedFocusModes(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

getSupportedWhiteBalance

getSupportedWhiteBalance(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

getZoomRatios

getZoomRatios(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

hasTorch

hasTorch(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

isLicenseActivated

isLicenseActivated(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

isLicenseExpired

isLicenseExpired(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

isZoomSupported

isZoomSupported(onSuccess, onError?);

Version 1.0.0 `

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

libraryVersion

libraryVersion(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

loadLicenseFile

loadLicenseFile(onSuccess, onError?, fileContent: String);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • fileContent (String) a string that consists the content of the license file obtained License Server.

lowContrastDecodingEnabled

lowContrastDecodingEnabled(onSuccess, onError?, enabled: Boolean);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • enabled (Boolean) true to enable.

playBeepSound

playBeepSound(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

regionOfInterestHeight

regionOfInterestHeight(onSuccess, onError?, roiHeight: number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • roiHeight (Number) This is the height of the ROI rectangle. The default value is 0, indicating the full image height is used. Otherwise, roiHeight can be a value up to (imageHeight � roiHeight).

regionOfInterestLeft

regionOfInterestLeft(onSuccess, onError?, column: number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • column (Number) This is the x or column coordinate of the ROI upper-left corner. The default value is 0.

regionOfInterestTop

regionOfInterestTop(onSuccess, onError?, row: number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • row (Number) This is the y or row coordinate of the ROI top-left corner. The default value is 0.

regionOfInterestWidth

regionOfInterestWidth(onSuccess, onError?, roiWidth: number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • roiWidth (Number) This is the width of the ROI rectangle. The default value is 0, indicating the full image width is used. Otherwise, roiWidth can be a value up to (imageWidth � roiWidth).

setAutoFocusResetByCount

setAutoFocusResetByCount(onSuccess, onError?, mEnabled: Boolean);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • mEnabled (Boolean) if true then autofocus restart every 20 frames of no decode is enabled.

setCameraType

setCameraType(onSuccess, onError?, cameraType: Number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • cameraType (CameraType)

setCameraZoom

setCameraZoom(onSuccess, onError?, enabled: Boolean,, zoom: number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • enabled (Boolean) true to enable the feature.

  • zoom (Float) float value that specifies the zoom value that camera should use.

setDecoderResolution

setDecoderResolution(onSuccess, onError?, resolution: number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • resolution (Resolution) Resolution to use for decoding.

setDecoderToleranceLevel

setDecoderToleranceLevel(onSuccess, onError?, toleranceLevel: number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • toleranceLevel (Number) sets the tolerance level.

setEncodingCharsetName

setEncodingCharsetName(onSuccess, onError?, charsetName: String);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • charsetName (String) Charset to use for encoding barcode data.

setExactlyNBarcodes

setExactlyNBarcodes(onSuccess, onError?, enable: boolean);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • enable (Boolean)

setExposureSensitivity

setExposureSensitivity(onSuccess, onError?, iso: number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • iso (String) sets the exposure sensitivity to ep.

setExposureTime

setExposureTime(onSuccess, onError?, ep: number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • ep (Long) sets the exposure time to ep.

setFocus

setFocus(onSuccess, onError?, focus: number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • focus (Focus) Focus mode is set to focus.

setFocusDistance

setFocusDistance(onSuccess, onError?, distance: number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • distance (Float) sets the focus distance to distance.

setNumberOfBarcodesToDecode

setNumberOfBarcodesToDecode(onSuccess, onError?, num: number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • num (Number)

setTorch

setTorch(onSuccess, onError?, on: boolean);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • on (Boolean) whether to turn on torch.

setWhiteBalance

setWhiteBalance(onSuccess, onError?, enable: boolean, mBalance: number);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • enable (Boolean) is true then thsi feature is enabled.

  • mBalance (String) sets the white balance mode if enable is true.

startCameraPreview

startCameraPreview(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

startDecoding

startDecoding(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

stopCameraPreview

stopCameraPreview(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

stopDecoding

stopDecoding(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

stringFromSymbologyType

stringFromSymbologyType(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • type (SymbologyType) The SymbologyType that you want returned as a string.

CameraTypeValueOf

CameraTypeValueOf(onSuccess, onError?, name: String);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

CameraTypeValues

CameraTypeValues(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

FocusValueOf

FocusValueOf(onSuccess, onError?, name: String);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

FocusValues

FocusValues(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

SymbologyTypeValueOf

SymbologyTypeValueOf(onSuccess, onError?, name: String);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

SymbologyTypeValues

SymbologyTypeValues(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

setSymbologyProperties

setSymbologyProperties(onSuccess, onError?, symbology: String, props);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • symbology (String)

  • props (SymbologyProperties)

setCameraButtons

setCameraButtons(onSuccess, onError?, camerabuttons);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • camerabuttons (CameraButtons[])

showCrossHair

showCrossHair(onSuccess, onError?, show: boolean);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • show (Boolean)

toggleCamera

toggleCamera(onSuccess, onError?);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

enableNativeZoom

enableNativeZoom(onSuccess, onError?, enable: boolean);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • enable: (Boolean) Enable or disbale the nativeZoom

enableSeekBarZoom

enableSeekBarZoom(onSuccess, onError?, enable: boolean);

Version 1.0.0

NOT-SUPPORTED Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • enable: (Boolean) Enable or disbale the seekbar

enableAugmentedReality

enableAugmentedReality(onSuccess, onError?, enable: boolean);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • enable: (Boolean) Enable or disbale the augmentedRality

ar_showVisualizeBarcodes

ar_showVisualizeBarcodes(onSuccess, onError?, enable: boolean);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • enable: (Boolean) Enable or disbale

ar_detectBarcode

ar_detectBarcode(onSuccess, onError?, data: string);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • data: (String) The barcodedata that the AR is looking for.

ar_showDetails

ar_showDetails(onSuccess, onError?, html: string);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • html: (String) A normal html string that get displayed, when the barcode gets decoted.

enableAllDecoders

enableAllDecoders(onSuccess, onError?, enable: boolean);

Version 1.0.0

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • enable: (Boolean) Enable or disable all decoders.

activateEDKLicense

activateEDKLicense(onSuccess, onError?, mFileName: string, mCustomerID: string);

Version 1.0.1

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • mFileName: (String) The path to the EDK-File.

  • mCustomerID: (String) The customerID for the EDK-Key.

initCaptureID

initCaptureID(onSuccess, onError?, message: string, showTextMessage: boolean);

Version 1.0.8

Parameters:

  • onSuccess: Required callback invoked if the plugin was successfully notified.

  • onError: Optional callback invoked in case of an error during notifying the plugin.

  • message: (String) Optional on Android we show a MessageBox with the message, why the user should allow the permissions.

  • showTextMessage: (Boolean) Optional if set to true, the MessageBox shows the message string.

PhoneGap Build

Example Apps