dynamsoft-capture-vision-cordova - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "dynamsoft-capture-vision-cordova",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Dynamsoft Capture Vision Cordova SDK",
@@ -5,0 +5,0 @@ "homepage": "https://www.dynamsoft.com/capture-vision/docs/introduction",

www/BarcodeSettings.d.ts

 export interface DBRRuntimeSettings {
+    /**
+    * A combined value of EnumBarcodeFormat members.
+    */
     barcodeFormatIds: number;
+    /**
+    * A combined value of EnumBarcodeFormat_2 members.
+    */
     barcodeFormatIds_2: number;
+    /**
+    * Defines how many barcodes you want decode from a single image.
+    */
     expectedBarcodesCount: number;
+    /**
+    * Defines the maximum time consumption on processing a single image.
+    */
     timeout: number;
 }
 export declare enum EnumDBRPresetTemplate {
+    /**
+    * The default setting for processing the video streaming.
+    */
     DEFAULT = 0,
+    /**
+    * Use this template when processing single barcode under the video streaming.
+    */
     VIDEO_SINGLE_BARCODE = 1,
+    /**
+    * Use this template for higher speed when processing the video streaming.
+    */
     VIDEO_SPEED_FIRST = 2,
+    /**
+    * Use this template for higher read rate when processing the video streaming.
+    */
     VIDEO_READ_RATE_FIRST = 3,
+    /**
+    * Use this template for higher speed when processing a still image.
+    */
     IMAGE_SPEED_FIRST = 4,
+    /**
+    * Use this template for higher read rate when processing a still image.
+    */
     IMAGE_READ_RATE_FIRST = 5,
+    /**
+    * The default setting for processing a still image.
+    */
     IMAGE_DEFAULT = 6
 }
+/**
+* The first group of barcode formats.
+*/
 export declare enum EnumBarcodeFormat {
@@ -51,2 +87,5 @@ BF_ALL = -29360129,
 }
+/**
+* The second group of barcode formats.
+*/
 export declare enum EnumBarcodeFormat_2 {
@@ -53,0 +92,0 @@ BF2_AUSTRALIANPOST = 8388608,

www/BarcodeSettings.js

@@ -6,10 +6,34 @@ "use strict";
 (function (EnumDBRPresetTemplate) {
+    /**
+    * The default setting for processing the video streaming.
+    */
     EnumDBRPresetTemplate[EnumDBRPresetTemplate["DEFAULT"] = 0] = "DEFAULT";
+    /**
+    * Use this template when processing single barcode under the video streaming.
+    */
     EnumDBRPresetTemplate[EnumDBRPresetTemplate["VIDEO_SINGLE_BARCODE"] = 1] = "VIDEO_SINGLE_BARCODE";
+    /**
+    * Use this template for higher speed when processing the video streaming.
+    */
     EnumDBRPresetTemplate[EnumDBRPresetTemplate["VIDEO_SPEED_FIRST"] = 2] = "VIDEO_SPEED_FIRST";
+    /**
+    * Use this template for higher read rate when processing the video streaming.
+    */
     EnumDBRPresetTemplate[EnumDBRPresetTemplate["VIDEO_READ_RATE_FIRST"] = 3] = "VIDEO_READ_RATE_FIRST";
+    /**
+    * Use this template for higher speed when processing a still image.
+    */
     EnumDBRPresetTemplate[EnumDBRPresetTemplate["IMAGE_SPEED_FIRST"] = 4] = "IMAGE_SPEED_FIRST";
+    /**
+    * Use this template for higher read rate when processing a still image.
+    */
     EnumDBRPresetTemplate[EnumDBRPresetTemplate["IMAGE_READ_RATE_FIRST"] = 5] = "IMAGE_READ_RATE_FIRST";
+    /**
+    * The default setting for processing a still image.
+    */
     EnumDBRPresetTemplate[EnumDBRPresetTemplate["IMAGE_DEFAULT"] = 6] = "IMAGE_DEFAULT";
 })(EnumDBRPresetTemplate = exports.EnumDBRPresetTemplate || (exports.EnumDBRPresetTemplate = {}));
+/**
+* The first group of barcode formats.
+*/
 var EnumBarcodeFormat;
@@ -51,2 +75,5 @@ (function (EnumBarcodeFormat) {
 })(EnumBarcodeFormat = exports.EnumBarcodeFormat || (exports.EnumBarcodeFormat = {}));
+/**
+* The second group of barcode formats.
+*/
 var EnumBarcodeFormat_2;
@@ -53,0 +80,0 @@ (function (EnumBarcodeFormat_2) {

www/BasicStructures.d.ts

 export interface Quadrilateral {
+    /**
+    * Vertex coordinates of the quadrilateral.
+    */
     points: Point[];
 }
 export interface Point {
+    /**
+    * X coordinate of the point.
+    */
     x: number;
+    /**
+    * Y coordinate of the point.
+    */
     y: number;
 }
 export interface Region {
+    /**
+    * Y coordinate of the buttom border of the region.
+    */
     regionBottom: number;
+    /**
+    * X coordinate of the right border of the region.
+    */
     regionRight: number;
+    /**
+    * X coordinate of the left border of the region.
+    */
     regionLeft: number;
+    /**
+    * Y coordinate of the top border of the region.
+    */
     regionTop: number;
+    /**
+    * 1/True: the coordinates are measured by percentage.
+    * 0/False: the coordinates are measured by pixel distance.
+    */
     regionMeasuredByPercentage: number | boolean;
 }
 export interface Rect {
+    /**
+    * X coordinate of the top-left vertex of the rectangle.
+    */
     x: number;
+    /**
+    * Y coordinate of the top-left vertex of the rectangle.
+    */
     y: number;
+    /**
+    * The width of the rectangle.
+    */
     width: number;
+    /**
+    * The height of the rectangle.
+    */
     height: number;
 }

www/CameraSettings.d.ts

 import { Rect } from "./BasicStructures";
 export interface TorchButton {
+    /**
+    * Defines the location of the torch button.
+    */
     location: Rect;
+    /**
+    * True: the torch will be displayed.
+    * False: the torch will be hide.
+    */
     visible: boolean;
+    /**
+    * The file path of the torch on image.
+    * When the torch is on, this image will be displayed as the torch image.
+    */
     torchOnImage: string;
+    /**
+    * The file path of the torch off image.
+    * When the torch is off, this image will be displayed as the torch image.
+    */
     torchOffImage: string;
 }

www/DCVBarcodeReader.d.ts

@@ -5,12 +5,42 @@ import { BarcodeResult } from './BarcodeResult';
     private constructor();
+    /**
+    * Create an instance of the DCVBarcode reader.
+    */
     static createInstance(): Promise<DCVBarcodeReader>;
+    /**
+    * Initialize the license with a license key.
+    */
     static initLicense(license: String): Promise<void>;
+    /**
+    * Get the version of the barcode reader library.
+    */
     static getVersion(): Promise<String>;
+    /**
+    * Start barcode decoding from the video streaming.
+    */
     startScanning(): void;
+    /**
+    * Stop barcode decoding from the video streaming.
+    */
     stopScanning(): void;
+    /**
+    * Register a listener to receive callback when barcode result is output.
+    */
     addResultListener(listener: (results: BarcodeResult[]) => void): void;
+    /**
+    * Get the current runtime settings as a DBRRuntimeSettings object.
+    */
     getRuntimeSettings(): Promise<DBRRuntimeSettings>;
+    /**
+    * Output the current runtime settings as a string.
+    */
     outputSettingsToString(): Promise<String>;
+    /**
+    * Update the current runtime settings with a DBRRuntimeSettings object / a preset template / a JSON string.
+    */
     updateRuntimeSettings(settings: String | DBRRuntimeSettings | EnumDBRPresetTemplate): Promise<void>;
+    /**
+    * Reset the runtime settings.
+    */
     resetRuntimeSettings(): void;
 }

www/DCVBarcodeReader.js

@@ -11,2 +11,5 @@ "use strict";
     }
+    /**
+    * Create an instance of the DCVBarcode reader.
+    */
     static createInstance() {
@@ -22,2 +25,5 @@ let promise = new Promise(function (resolve, reject) {
     }
+    /**
+    * Initialize the license with a license key.
+    */
     static initLicense(license) {
@@ -31,2 +37,5 @@ let promise = new Promise(function (resolve, reject) {
     }
+    /**
+    * Get the version of the barcode reader library.
+    */
     static getVersion() {
@@ -40,11 +49,23 @@ let promise = new Promise(function (resolve, reject) {
     }
+    /**
+    * Start barcode decoding from the video streaming.
+    */
     startScanning() {
         (0, exec_1.default)(null, null, 'DynamsoftCordovaPlugin', 'startScanning', []);
     }
+    /**
+    * Stop barcode decoding from the video streaming.
+    */
     stopScanning() {
         (0, exec_1.default)(null, null, 'DynamsoftCordovaPlugin', 'stopScanning', []);
     }
+    /**
+    * Register a listener to receive callback when barcode result is output.
+    */
     addResultListener(listener) {
         (0, exec_1.default)(listener, null, 'DynamsoftCordovaPlugin', 'setTextResultListener', []);
     }
+    /**
+    * Get the current runtime settings as a DBRRuntimeSettings object.
+    */
     getRuntimeSettings() {
@@ -60,2 +81,5 @@ let promise = new Promise(function (resolve, reject) {
     }
+    /**
+    * Output the current runtime settings as a string.
+    */
     outputSettingsToString() {
@@ -71,2 +95,5 @@ let promise = new Promise(function (resolve, reject) {
     }
+    /**
+    * Update the current runtime settings with a DBRRuntimeSettings object / a preset template / a JSON string.
+    */
     updateRuntimeSettings(settings) {
@@ -80,2 +107,5 @@ let promise = new Promise(function (resolve, reject) {
     }
+    /**
+    * Reset the runtime settings.
+    */
     resetRuntimeSettings() {
@@ -82,0 +112,0 @@ (0, exec_1.default)(null, null, 'DynamsoftCordovaPlugin', 'resetRuntimeSettings', []);

www/DCVCameraEnhancer.d.ts

 import { Region } from './BasicStructures';
 export declare class DCVCameraEnhancer {
     private constructor();
+    /**
+    * Create an instance of DCVCameraEnhancer.
+    */
     static createInstance(): Promise<DCVCameraEnhancer>;
+    /**
+    * Open the camera.
+    */
     open(): Promise<void>;
+    /**
+    * Close the camera.
+    */
     close(): Promise<void>;
+    /**
+    * Trun on the torch.
+    */
     turnOnTorch(): Promise<void>;
+    /**
+    * Trun off the torch.
+    */
     turnOffTorch(): Promise<void>;
+    /**
+    * Specify a region of interest with a region object.
+    */
     setScanRegion(region: Region): Promise<void>;
+    /**
+    * Set whether to display the scan region.
+    */
     setScanRegionVisible(isVisible: boolean): void;
 }

www/DCVCameraEnhancer.js

@@ -16,2 +16,5 @@ "use strict";
     }
+    /**
+    * Create an instance of DCVCameraEnhancer.
+    */
     static createInstance() {
@@ -25,2 +28,5 @@ let promise = new Promise(function (resolve, reject) {
     }
+    /**
+    * Open the camera.
+    */
     open() {
@@ -32,2 +38,5 @@ let promise = new Promise(function (resolve, reject) {
     }
+    /**
+    * Close the camera.
+    */
     close() {
@@ -39,2 +48,5 @@ let promise = new Promise(function (resolve, reject) {
     }
+    /**
+    * Trun on the torch.
+    */
     turnOnTorch() {
@@ -46,2 +58,5 @@ let promise = new Promise(function (resolve, reject) {
     }
+    /**
+    * Trun off the torch.
+    */
     turnOffTorch() {
@@ -53,2 +68,5 @@ let promise = new Promise(function (resolve, reject) {
     }
+    /**
+    * Specify a region of interest with a region object.
+    */
     setScanRegion(region) {
@@ -63,2 +81,5 @@ if (region) {
     }
+    /**
+    * Set whether to display the scan region.
+    */
     setScanRegionVisible(isVisible) {
@@ -65,0 +86,0 @@ (0, exec_1.default)(null, null, 'DynamsoftCordovaPlugin', 'setScanRegionVisible', [isVisible]);

www/DCVCameraView.js

@@ -50,3 +50,10 @@ "use strict";
         });
+        this.createDceView();
     }
+    createDceView() {
+        (0, exec_1.default)(null, null, 'DynamsoftCordovaPlugin', 'createDceView', null);
+    }
+    /**
+    * Bind the instance of DCVCameraView to an HTML element.
+    */
     bindToHtmlElement(element) {
@@ -58,5 +65,12 @@ this.htmlElement = element;
     }
+    /**
+    * Set whether to display overlays to highlight the decoded barcodes.
+    */
     setOverlayVisible(isVisible) {
         (0, exec_1.default)(null, null, 'DynamsoftCordovaPlugin', 'setOverlayVisible', [isVisible]);
     }
+    /**
+    * Set the torch button with a TorchButton object.
+    * You can configure the position, images and visibility of the button.
+    */
     setTorchButton(torchButton) {
@@ -63,0 +77,0 @@ (0, exec_1.default)(null, null, 'DynamsoftCordovaPlugin', 'setTorchButton', [torchButton]);

www/index.d.ts

 declare module Dynamsoft {
     export interface Quadrilateral {
+        /**
+        * Vertex coordinates of the quadrilateral.
+        */
         points: Point[];
     }
     export interface Point {
+        /**
+        * X coordinate of the point.
+        */
         x: number;
+        /**
+        * Y coordinate of the point.
+        */
         y: number;
     }
     export interface Region {
+        /**
+        * Y coordinate of the buttom border of the region.
+        */
         regionBottom: number;
+        /**
+        * X coordinate of the right border of the region.
+        */
         regionRight: number;
+        /**
+        * X coordinate of the left border of the region.
+        */
         regionLeft: number;
+        /**
+        * Y coordinate of the top border of the region.
+        */
         regionTop: number;
+        /**
+        * 1/True: the coordinates are measured by percentage.
+        * 0/False: the coordinates are measured by pixel distance.
+        */
         regionMeasuredByPercentage: number | boolean;
     }
     export interface Rect {
+        /**
+        * X coordinate of the top-left vertex of the rectangle.
+        */
         x: number;
+        /**
+        * Y coordinate of the top-left vertex of the rectangle.
+        */
         y: number;
+        /**
+        * The width of the rectangle.
+        */
         width: number;
+        /**
+        * The height of the rectangle.
+        */
         height: number;
@@ -51,16 +88,52 @@ }
     export interface DBRRuntimeSettings {
+        /**
+        * A combined value of EnumBarcodeFormat members.
+        */
         barcodeFormatIds: number;
+        /**
+        * A combined value of EnumBarcodeFormat_2 members.
+        */
         barcodeFormatIds_2: number;
+        /**
+        * Defines how many barcodes you want decode from a single image.
+        */
         expectedBarcodesCount: number;
+        /**
+        * Defines the maximum time consumption on processing a single image.
+        */
         timeout: number;
     }
     export enum EnumDBRPresetTemplate {
+        /**
+        * The default setting for processing the video streaming.
+        */
         DEFAULT = 0,
+        /**
+        * Use this template when processing single barcode under the video streaming.
+        */
         VIDEO_SINGLE_BARCODE = 1,
+        /**
+        * Use this template for higher speed when processing the video streaming.
+        */
         VIDEO_SPEED_FIRST = 2,
+        /**
+        * Use this template for higher read rate when processing the video streaming.
+        */
         VIDEO_READ_RATE_FIRST = 3,
+        /**
+        * Use this template for higher speed when processing a still image.
+        */
         IMAGE_SPEED_FIRST = 4,
+        /**
+        * Use this template for higher read rate when processing a still image.
+        */
         IMAGE_READ_RATE_FIRST = 5,
+        /**
+        * The default setting for processing a still image.
+        */
         IMAGE_DEFAULT = 6
     }
+    /**
+    * The first group of barcode formats.
+    */
     export enum EnumBarcodeFormat {
@@ -101,2 +174,6 @@ BF_ALL = -29360129,
     }
+
+    /**
+    * The second group of barcode formats.
+    */
     export enum EnumBarcodeFormat_2 {
@@ -117,5 +194,20 @@ BF2_AUSTRALIANPOST = 8388608,
     export interface TorchButton {
+        /**
+        * Defines the location of the torch button.
+        */
         location: Rect;
+        /**
+        * True: the torch will be displayed.
+        * False: the torch will be hide.
+        */
         visible: boolean;
+        /**
+        * A base 64 string that specify the torch on image.
+        * When the torch is on, this image will be displayed as the torch image.
+        */
         torchOnImage: string;
+        /**
+        * A base 64 string that specify the torch off image.
+        * When the torch is off, this image will be displayed as the torch image.
+        */
         torchOffImage: string;
@@ -125,11 +217,51 @@ }
         private constructor();
+
+        /**
+        * Create an instance of the DCVBarcode reader.
+        */
         static createInstance(): Promise<DCVBarcodeReader>;
+        
+        /**
+        * Initialize the license with a license key.
+        */
         static initLicense(license: String): Promise<void>;
+
+        /**
+        * Get the version of the barcode reader library.
+        */
         static getVersion(): Promise<String>;
+
+        /**
+        * Start barcode decoding from the video streaming.
+        */
         startScanning(): void;
+        
+        /**
+        * Stop barcode decoding from the video streaming.
+        */
         stopScanning(): void;
+
+        /**
+        * Register a listener to receive callback when barcode result is output.
+        */
         addResultListener(listener: (results: BarcodeResult[]) => void): void;
+
+        /**
+        * Get the current runtime settings as a DBRRuntimeSettings object.
+        */
         getRuntimeSettings(): Promise<DBRRuntimeSettings>;
+
+        /**
+        * Output the current runtime settings as a string.
+        */
         outputSettingsToString(): Promise<String>;
+
+        /**
+        * Update the current runtime settings with a DBRRuntimeSettings object / a preset template / a JSON string.
+        */
         updateRuntimeSettings(settings: String | DBRRuntimeSettings | EnumDBRPresetTemplate): Promise<void>;
+
+        /**
+        * Reset the runtime settings.
+        */
         resetRuntimeSettings(): void;
@@ -140,7 +272,25 @@ }
         static createInstance(): Promise<DCVCameraEnhancer>;
+        /**
+        * Open the camera.
+        */
         open(): Promise<void>;
+        /**
+        * CLose the camera.
+        */
         close(): Promise<void>;
+        /**
+        * Turn on the torch.
+        */
         turnOnTorch(): Promise<void>;
+        /**
+        * Turn off the torch.
+        */
         turnOffTorch(): Promise<void>;
+        /**
+        * Specify a region of interest with a region object.
+        */
         setScanRegion(region: Region): Promise<void>;
+        /**
+        * Set whether to display the scan region.
+        */
         setScanRegionVisible(isVisible: boolean): void;
@@ -155,4 +305,14 @@ }
         constructor();
+        /**
+        * Bind the instance of DCVCameraView to an HTML element.
+        */
         bindToHtmlElement(element: HTMLElement): void;
+        /**
+        * Set whether to display overlays to highlight the decoded barcodes.
+        */
         setOverlayVisible(isVisible: boolean): void;
+        /**
+        * Set the torch button with a TorchButton object.
+        * You can configure the position, images and visibility of the button.
+        */
         setTorchButton(torchButton: TorchButton): void;
@@ -159,0 +319,0 @@ private set htmlElementProp(value);

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

197412

increased by6.77%

Lines of code

1956

increased by32.25%

Worsened metrics

Number of package files

46

decreased by-4.17%

No dependency changes