dynamsoft-capture-vision-react-native 3.0.5201 → 3.2.5000

package/src/cvr/CaptureVisionRouter.tsx

@@ -59,6 +59,24 @@ export class CaptureVisionRouter {
     return cvr = new CaptureVisionRouter();
   }
 
+
+  /**
+   * Sets the global number of threads used internally for model execution.
+   *
+   * @param intraOpNumThreads - Number of threads used internally for model execution. Valid range: [0, 256].
+   * If the value is outside the range [0, 256], it will be treated as 0 (default).
+   */
+  static setGlobalIntraOpNumThreads(intraOpNumThreads: number) {
+    CvrModule.setGlobalIntraOpNumThreads(intraOpNumThreads);
+  }
+
+  /**
+   * Clears all deep learning models from buffer to free up memory.
+   */
+  static clearDLModelBuffers() {
+    CvrModule.clearDLModelBuffers();
+  }
+
   /**
    * Initiates a capturing process based on a specified template. This process is repeated for each image fetched from the source.
    * <p>Code Snippet:</p>
@@ -101,6 +119,16 @@ export class CaptureVisionRouter {
     return CvrModule.stopCapturing()
   }
 
+  /**
+   * Switch the capturing template during the image processing workflow.
+   *
+   * @param templateName -The name of the new capturing template to apply.
+   *
+   * @return Promise<void> - A promise that resolves when the template switch is successful. If the template switch fails, the promise will be rejected with an error.
+   */
+  switchCapturingTemplate(templateName: string): Promise<void> {
+    return CvrModule.switchCapturingTemplate(templateName)
+  }
   /**
    * Sets up an image source to provide images for continuous processing.
    * <p>Code Snippet:</p>
@@ -164,7 +192,7 @@ export class CaptureVisionRouter {
               processingDocumentResult.deskewedImageResultItems[i]!!.imageData = imageArr[i]!!;
             }
           }
-          if(processingDocumentResult && processingDocumentResult.enhancedImageResultItems && processingDocumentResult.enhancedImageResultItems.length > 0) {
+          if (processingDocumentResult && processingDocumentResult.enhancedImageResultItems && processingDocumentResult.enhancedImageResultItems.length > 0) {
             installMethods();
             let imageArr: ImageData[] = global.getCurrentEnhancedImages();
             for (let i = 0; i < processingDocumentResult.enhancedImageResultItems.length; i++) {
@@ -421,7 +449,7 @@ export class CaptureVisionRouter {
     try {
       if (barcodeFormatIds != undefined) {
         settings!!.barcodeSettings!!.barcodeFormatIds = undefined
-        let settingsTemp: SimplifiedCaptureVisionSettings = JSON.parse(JSON.stringify(settings));
+        let settingsTemp: SimplifiedCaptureVisionSettings = JSON.parse(JSON.stringify(settings)) as SimplifiedCaptureVisionSettings;
         settingsTemp!!.barcodeSettings!!._barcodeFormatIdsNumberString = barcodeFormatIds.toString()
         settings!!.barcodeSettings!!.barcodeFormatIds = barcodeFormatIds
         await CvrModule.updateSettings(settingsTemp, templateName)
@@ -460,7 +488,7 @@ export class CaptureVisionRouter {
    * @param includeDefaultValues - Whether to include default values in the output.
    * @return {Promise<string>} - A promise that resolves a JSON string that contains settings for the specified templateName.
    * */
-  outputSettings(templateName: string, includeDefaultValues:boolean): Promise<string> {
+  outputSettings(templateName: string, includeDefaultValues: boolean): Promise<string> {
     return CvrModule.outputSettings(templateName, includeDefaultValues)
   }
 
@@ -471,7 +499,7 @@ export class CaptureVisionRouter {
    * @param includeDefaultValues - Whether to include default values in the output.
    * @return {Promise<void>} - A promise that resolves or rejected with an error when the operation has completed.
    * */
-  outputSettingsToFile(templateName: string, file: string, includeDefaultValues:boolean): Promise<void> {
+  outputSettingsToFile(templateName: string, file: string, includeDefaultValues: boolean): Promise<void> {
     return CvrModule.outputSettingsToFile(templateName, file, includeDefaultValues)
   }
 
@@ -610,7 +638,7 @@ export class IntermediateResultManager {
    * @param imageHashId - The image hash ID. Get from {@link CapturedResult.originalImageHashId}, {@link DecodedBarcodesResult.originalImageHashId},
    *    {@link ProcessedDocumentResult.originalImageHashId}, {@link RecognizedTextLinesResult.originalImageHashId}.
    *
-   * @remarks `Do not call this method outside the CapturedResultReceiver callback where you get the hashId, otherwise you will not get any valid ImageData.`
+   * @remarks `Do not call this method after calling stopCapturing() or outside the CapturedResultReceiver callback where you get the hashId, otherwise you will not get any valid ImageData.`
    * @see {@link CaptureVisionRouter.addResultReceiver}
    * @see {@link CapturedResultReceiver}
    * */

package/src/dbr/BarcodeDetails.tsx

@@ -0,0 +1,51 @@
+import {EnumQRCodeErrorCorrectionLevel} from "./EnumQRCodeErrorCorrectionLevel";
+
+export interface QRCodeDetails {
+  rows: number;
+  columns: number;
+  errorCorrectionLevel: number;
+  version: number;
+  model: number;
+  mode: number;
+  page: number;
+  totalPage: number;
+  parityData: number;
+  dataMaskPattern: number;
+  codewords: number[];
+}
+
+
+export interface DataMatrixDetails {
+  rows: number;
+  columns: number;
+  dataRegionRows: number;
+  dataRegionColumns: number;
+  dataRegionNumber: number;
+}
+
+export interface PDF417Details {
+  rows: number;
+  columns: number;
+  errorCorrectionLevel: EnumQRCodeErrorCorrectionLevel;
+  hasLeftRowIndicator: boolean;
+  hasRightRowIndicator: boolean;
+  codewords: number[];
+}
+
+export interface AztecDetails {
+  rows: number;
+  columns: number;
+  layerNumber: number;
+}
+
+export interface OneDCodeDetails {
+  startCharsBytes: number[];
+  stopCharsBytes: number[];
+  checkDigitBytes: number[];
+  startPatternRange_lower: number;
+  startPatternRange_upper: number;
+  middlePatternRange_lower: number;
+  middlePatternRange_upper: number;
+  endPatternRange_lower: number;
+  endPatternRange_upper: number;
+}

package/src/dbr/BarcodeResultItem.tsx

@@ -1,5 +1,6 @@
 import type {CapturedResultItem, Quadrilateral, EnumCapturedResultItemType} from "../core";
 import type {EnumBarcodeFormat} from "./EnumBarcodeFormat";
+import type {AztecDetails, DataMatrixDetails, OneDCodeDetails, PDF417Details, QRCodeDetails} from "./BarcodeDetails";
 
 /**
  * Interface BarcodeResultItem extends {@link CapturedResultItem}, represents a barcode result item decoded by barcode reader engine.
@@ -42,4 +43,14 @@ export interface BarcodeResultItem extends CapturedResultItem{
 
     /**Indicates whether the barcode is a Direct Part Marking (DPM) barcode.*/
     isDPM: boolean;
+
+    qrCodeDetails?: QRCodeDetails;
+
+    oneDCodeDetails?: OneDCodeDetails;
+
+    dataMatrixDetails?: DataMatrixDetails;
+
+    pdf417Details?: PDF417Details;
+
+    aztecDetails?: AztecDetails;
 }

package/src/dbr/EnumBarcodeFormat.tsx

@@ -81,6 +81,8 @@ const EnumBarcodeFormat = {
     BF_TWO_DIGIT_ADD_ON:BigInt(0x400000),
     BF_FIVE_DIGIT_ADD_ON:BigInt(0x800000),
     BF_MATRIX_25:BigInt(0x1000000000),
+    BF_TELEPEN:BigInt(0x2000000000),
+    BF_TELEPEN_NUMERIC:BigInt(0x4000000000),
 
     /**Combined value of BF2_USPSINTELLIGENTMAIL, BF2_POSTNET, BF2_PLANET, BF2_AUSTRALIANPOST, BF2_RM4SCC.*/
     BF_POSTALCODE:BigInt(0x3F0000000000000),

package/src/dbr/EnumDeblurMode.tsx

@@ -5,6 +5,7 @@
  * @see {@link SimplifiedBarcodeReaderSettings.deblurModes}
  * */
 export enum EnumDeblurMode {
+    DM_END = -1,
   /** Skips the process, no deblurring is applied. */
   DM_SKIP = 0x0,
   /** Applies a direct binarization algorithm for generating the binary image. */

package/src/dbr/EnumLocalizationMode.tsx

@@ -3,6 +3,7 @@
  * @see {@link SimplifiedBarcodeReaderSettings.localizationModes}
  * */
 export enum EnumLocalizationMode {
+    LM_END = -1,
     /** Omits the localization process entirely. */
     LM_SKIP = 0x0,
     /** Automatic localization mode selection; not yet implemented. */

package/src/dbr/EnumQRCodeErrorCorrectionLevel.tsx

@@ -0,0 +1,6 @@
+export enum EnumQRCodeErrorCorrectionLevel {
+  QRECL_ERROR_CORRECTION_H = 0,
+  QRECL_ERROR_CORRECTION_L = 1,
+  QRECL_ERROR_CORRECTION_M = 2,
+  QRECL_ERROR_CORRECTION_Q = 3,
+}

package/src/dbr/index.tsx

@@ -4,4 +4,6 @@ export * from "./DecodedBarcodesResult"
 export * from "./EnumBarcodeFormat"
 export * from "./EnumDeblurMode"
 export * from "./EnumLocalizationMode"
+export * from "./BarcodeDetails"
+export * from "./EnumQRCodeErrorCorrectionLevel"
 export type {SimplifiedBarcodeReaderSettings} from "./SimplifiedBarcodeReaderSettings"

package/src/dce/CameraEnhancer.tsx

@@ -1,7 +1,7 @@
 import {ImageSourceAdapter, type DSRect} from "../core";
 import {NativeModules, Platform} from "react-native";
 import {CameraView} from "./CameraView"
-import type {EnumCameraPosition} from "./EnumCameraPosition";
+import {EnumCameraPosition} from "./EnumCameraPosition";
 import type {EnumFocusMode} from "./EnumFocusMode";
 import type {EnumEnhancedFeatures} from "./EnumEnhancedFeatures";
 import type {EnumResolution} from "./EnumResolution";
@@ -86,17 +86,25 @@ export class CameraEnhancer extends ImageSourceAdapter {
    *
    * @param view - the CameraView element
    * */
-  setCameraView(view: CameraView) {
+  setCameraView(view: CameraView | null) {
     if (view) {
       DynamsoftCameraEnhancerModule.setCameraView(view.nativeCameraViewHandle);
+    } else {
+      DynamsoftCameraEnhancerModule.setCameraView(0);
     }
   }
 
   /**
    * Select a camera with a camera position.
    * @param position - One of the {@link EnumCameraPosition}
+   * @note {@link EnumCameraPosition.CP_BACK_DUAL_WIDE_AUTO} and {@link EnumCameraPosition.CP_BACK_ULTRA_WIDE} are only supported on iOS.
    * */
   selectCamera(position: EnumCameraPosition | number) {
+    if(Platform.OS !== "ios") {
+      if (position === EnumCameraPosition.CP_BACK_DUAL_WIDE_AUTO || position === EnumCameraPosition.CP_BACK_ULTRA_WIDE) {
+        position = EnumCameraPosition.CP_BACK;
+      }
+    }
     DynamsoftCameraEnhancerModule.selectCamera(position);
   }
 
@@ -179,10 +187,10 @@ export class CameraEnhancer extends ImageSourceAdapter {
    *
    *```
    * let scanRegion = {
-   *    top: 25,
-   *    bottom: 75,
-   *    left: 25,
-   *    right: 75,
+   *    top: 0.25,
+   *    bottom: 0.75,
+   *    left: 0.25,
+   *    right: 0.75,
    *    measuredInPercentage: true,
    * }
    * cameraEnhancer.setScanRegion(scanRegion);

package/src/dce/CameraView.tsx

@@ -25,8 +25,10 @@ const transformToNativeCameraViewProps = (props: CameraViewNativeProps | undefin
             scanLaserVisible: props?.scanLaserVisible,
             torchButton: props?.torchButton,
             torchButtonVisible: props?.torchButtonVisible,
+            cameraToggleButton: props?.cameraToggleButton,
+            cameraToggleButtonVisible: props?.cameraToggleButtonVisible,
         }
-    ))
+    )) as CameraViewNativeProps
 }
 type RefType = React.Component<CameraViewNativeProps> & Readonly<NativeMethods>;
 
@@ -48,7 +50,7 @@ const NativeCameraView: HostComponent<CameraViewNativeProps> = isTurboModuleEnab
  * @see {@link CameraEnhancer.setCameraView}
  */
 export class CameraView extends Component<CameraViewNativeProps, any> {
-    private readonly nativeCameraViewRef: React.RefObject<RefType> = React.createRef<RefType>();
+    private readonly nativeCameraViewRef: React.RefObject<RefType | null> = React.createRef<RefType>();
     private readonly nativeProps = transformToNativeCameraViewProps(this.props)
 
     /** @internal */
@@ -56,6 +58,12 @@ export class CameraView extends Component<CameraViewNativeProps, any> {
         return findNodeHandle(this.nativeCameraViewRef.current);
     }
 
+    componentDidMount() {
+      if(this.nativeProps.torchButton?.visible !== undefined) {
+        console.warn("The `torchButton.visible` property of CameraView has been deprecated, please use the `torchButtonVisible` property of CameraView")
+      }
+    }
+
     componentDidUpdate(prevProps: CameraViewNativeProps) {
         let nativePreProps = transformToNativeCameraViewProps(prevProps)
         let nativeProps = transformToNativeCameraViewProps(this.props)

package/src/dce/DynamsoftCameraViewNativeComponent.ts

@@ -64,6 +64,31 @@ export interface CameraViewNativeProps extends ViewProps {
     * Set the visibility of the torch button. Default is false.
     * */
     torchButtonVisible?: boolean
+
+    /**
+     * Add a camera toggle button that can switch camera position on your view.
+     * */
+    cameraToggleButton?: {
+        /**
+        * Set the top-left point and width and height of the camera toggle button.(All by px)
+        * */
+        location?: {
+            x?: Int32;
+            y?: Int32;
+            width?: Int32;
+            height?: Int32;
+        }
+
+        /**
+         *  The camera toggle button image.
+         * */
+        cameraToggleImageBase64?: string;
+    };
+
+    /**
+    * Set the visibility of the camera toggle button. Default is false.
+    * */
+    cameraToggleButtonVisible?: boolean
 }
 
 export default codegenNativeComponent<CameraViewNativeProps>(

package/src/dce/EnumCameraPosition.tsx

@@ -9,5 +9,17 @@ export enum EnumCameraPosition {
     /**
      * Use the front-facing camera.
      */
-    CP_FRONT
+    CP_FRONT,
+
+    /**
+     * Use the ultra-wide back-facing camera.
+     * @note iOS only. This option is not available on other platforms.
+     */
+    CP_BACK_ULTRA_WIDE,
+
+     /**
+     * Use the ultra-wide back-facing camera.
+     * @note iOS only. This option is not available on other platforms.
+     */
+    CP_BACK_DUAL_WIDE_AUTO,
 }

package/src/dce/EnumEnhancedFeatures.tsx

@@ -12,14 +12,13 @@ export enum EnumEnhancedFeatures {
 
   /**`Enhanced Focus`: The enhanced focus feature. DCE will support the camera in triggering auto-focus.*/
   EF_ENHANCED_FOCUS = 4,
-  EF_FAST_MODE = 8,
 
   /**`Auto Zoom`: The auto-zoom feature of DCE. By enabling this feature, the camera will automatically zoom in to the interest area.*/
-  EF_AUTO_ZOOM = 16,
+  EF_AUTO_ZOOM = 8,
 
   /**`Smart Torch`: Add a smart torch on the UI. The torch will be hided when the environment brightness is high and displayed when the brightness is low.*/
-  EF_SMART_TORCH = 32,
+  EF_SMART_TORCH = 16,
 
   /**Enable all.*/
-  EF_ALL = 63
+  EF_ALL = 31
 }

package/src/dce/ImageEditorView.tsx

@@ -52,7 +52,7 @@ type RefType = React.Component<ImageEditorViewNativeProps> & Readonly<NativeMeth
  */
 export class ImageEditorView extends Component<ImageEditorViewNativeProps, any> {
     // A Ref object pointing to the native ImageEditorView
-    private readonly nativeImageEditorViewRef: React.RefObject<RefType> = React.createRef<RefType>();
+    private readonly nativeImageEditorViewRef: React.RefObject<RefType | null> = React.createRef<RefType>();
     private drawingQuads: Array<Quadrilateral> | null | undefined;
 
     /** @internal */

package/src/dlr/CharacterResult.tsx

@@ -1,4 +1,4 @@
-
+import {Quadrilateral} from "../core";
 /**
  * The CharacterResult interface represents the result of a character recognition process.
  * It contains the characters recognized (high, medium, and low confidence),
@@ -22,4 +22,7 @@ export interface CharacterResult {
 
     /**The confidence of the character with low confidence.*/
     characterLConfidence: number;
+
+    /**The location of the character in a quadrilateral shape.*/
+    location: Quadrilateral;
 }

package/src/dlr/SimplifiedLabelRecognizerSettings.tsx

@@ -27,5 +27,7 @@ export interface SimplifiedLabelRecognizerSettings {
 
     /**Sets the threshold value that determines when the original image is scaled down.*/
     scaleDownThreshold?: number
+
+    /**Sets the maximum number of threads to be used in one task.*/
     maxThreadsInOneTask?: number
 }

package/src/dlr/TextLineResultItem.tsx

@@ -19,6 +19,11 @@ export interface TextLineResultItem extends CapturedResultItem {
      * */
     text: string;
 
+    /**
+     * The raw text content of the text line.
+     * */
+    rawText: string;
+
     /**
      * The confidence of the text line recognition result.
      * */

package/src/utility/EnumFilterType.tsx

@@ -0,0 +1,5 @@
+export enum EnumFilterType {
+  FT_HIGH_PASS = 0,
+  FT_SHARPEN = 1,
+  FT_SMOOTH = 2
+}