dynamsoft-capture-vision-react-native 2.4.2000-alpha.2 → 2.6.1002

package/src/core/EnumGrayscaleEnhancementMode.tsx

@@ -1,8 +1,41 @@
+/**
+ * Specifies the method employed to enhance images in grayscale.
+ * @see SimplifiedBarcodeReaderSettings.grayscaleEnhancementModes
+ */
 export enum EnumGrayscaleEnhancementMode {
-    GEM_SKIP = 0x0,
-    GEM_AUTO = 0x1,
-    GEM_GENERAL = 0x2,
-    GEM_GRAY_EQUALIZE = 0x4,
-    GEM_GRAY_SMOOTH = 0x8,
-    GEM_SHARPEN_SMOOTH = 0x10
-}
+  /**
+   * Disables any grayscale image preprocessing. Selecting this mode skips the preprocessing step,
+   * passing the image through to subsequent operations without modification.
+   */
+  GEM_SKIP = 0x0,
+
+  /**
+   * Automatic selection of grayscale enhancement mode. Currently, not supported.
+   * Future implementations may automatically choose the most suitable enhancement based on image analysis.
+   */
+  GEM_AUTO = 0x1,
+
+  /**
+   * Uses the original, unprocessed image for subsequent operations. This mode is selected when no specific
+   * grayscale enhancement is required, maintaining the image in its natural state.
+   */
+  GEM_GENERAL = 0x2,
+
+  /**
+   * Applies a grayscale equalization algorithm to the image, enhancing contrast and detail in gray level.
+   * Suitable for images with poor contrast.
+   */
+  GEM_GRAY_EQUALIZE = 0x4,
+
+  /**
+   * Implements a grayscale smoothing algorithm to reduce noise and smooth the image.
+   * This can be beneficial for images with high levels of grain or noise.
+   */
+  GEM_GRAY_SMOOTH = 0x8,
+
+  /**
+   * Enhances the image by applying both sharpening and smoothing algorithms. This mode aims to increase
+   * clarity and detail while reducing noise, offering a balanced approach to image preprocessing.
+   */
+  GEM_SHARPEN_SMOOTH = 0x10
+}

package/src/core/EnumGrayscaleTransformationMode.tsx

@@ -1,6 +1,30 @@
+/**
+ * Specifies the method employed to transform images in grayscale.
+ * @see SimplifiedBarcodeReaderSettings.grayscaleTransformationModes
+ */
 export enum EnumGrayscaleTransformationMode {
-    GTM_SKIP = 0x0,
-    GTM_INVERTED = 0x1,
-    GTM_ORIGINAL = 0x2,
-    GTM_AUTO = 0x4
-}
+  /**
+   * Bypasses grayscale transformation, leaving the image in its current state without any modification to its grayscale values.
+   * This mode is selected when no alteration of the grayscale data is desired, passing the image through to subsequent operations without modification.
+   */
+  GTM_SKIP = 0x0,
+
+  /**
+   * Applies an inversion to the grayscale values of the image, effectively transforming light elements to dark and vice versa.
+   * This mode is particularly useful for images with light text on dark backgrounds, enhancing visibility for further processing.
+   */
+  GTM_INVERTED = 0x1,
+
+  /**
+   * Maintains the original grayscale values of the image without any transformation. This mode is suited for images with
+   * dark elements on light backgrounds, ensuring the natural contrast and detail are preserved for subsequent analysis.
+   */
+  GTM_ORIGINAL = 0x2,
+
+  /**
+   * Delegates the choice of grayscale transformation to the library's algorithm, which automatically determines the most
+   * suitable transformation based on the image's characteristics. This mode is beneficial when the optimal transformation
+   * is not known in advance or varies across different images.
+   */
+  GTM_AUTO = 0x4
+}

package/src/core/EnumPixelFormat.tsx

@@ -1,48 +1,53 @@
+/**
+ * Defines the range of pixel formats that an image can have, specifying how color and transparency data are represented in each pixel of the image.
+ * @see ImageData.format
+ * */
 export enum EnumPixelFormat {
-    // 0:Black, 1:White
-    IPF_BINARY = 0,
+  /** 0:Black, 1:White. */
+  IPF_BINARY = 0,
 
-    // 0:White, 1:Black
-    IPF_BINARYINVERTED = 1,
+  /** 0:White, 1:Black. */
+  IPF_BINARYINVERTED = 1,
 
-    // 8-bit gray
-    IPF_GRAYSCALED = 2,
+  /** 8bit gray. */
+  IPF_GRAYSCALED = 2,
 
-    // NV21
-    IPF_NV21 = 3,
+  /** NV21 */
+  IPF_NV21 = 3,
 
-    // 16bit with RGB channel order stored in memory from high to low address
-    IPF_RGB_565 = 4,
+  /** 16bit with RGB channel order stored in memory from high to low address. */
+  IPF_RGB_565 = 4,
 
-    // 16bit with RGB channel order stored in memory from high to low address
-    IPF_RGB_555 = 5,
+  /** 16bit with RGB channel order stored in memory from high to low address. */
+  IPF_RGB_555 = 5,
 
-    // 24bit with RGB channel order stored in memory from high to low address
-    IPF_RGB_888 = 6,
+  /** 24bit with RGB channel order stored in memory from high to low address. */
+  IPF_RGB_888 = 6,
 
-    // 32bit with ARGB channel order stored in memory from high to low address
-    IPF_ARGB_8888 = 7,
+  /** 32bit with ARGB channel order stored in memory from high to low address. */
+  IPF_ARGB_8888 = 7,
 
-    // 48bit with RGB channel order stored in memory from high to low address
-    IPF_RGB_161616 = 8,
+  /** 48bit with RGB channel order stored in memory from high to low address. */
+  IPF_RGB_161616 = 8,
 
-    // 64bit with ARGB channel order stored in memory from high to low address
-    IPF_ARGB_16161616 = 9,
+  /** 64bit with ARGB channel order stored in memory from high to low address. */
+  IPF_ARGB_16161616 = 9,
 
-    // 32bit with ABGR channel order stored in memory from high to low address
-    IPF_ABGR_8888 = 10,
+  /** 32bit with ABGR channel order stored in memory from high to low address. */
+  IPF_ABGR_8888 = 10,
 
-    // 64bit with ABGR channel order stored in memory from high to low address
-    IPF_ABGR_16161616 = 11,
+  /** 64bit with ABGR channel order stored in memory from high to low address. */
+  IPF_ABGR_16161616 = 11,
 
-    // 24bit with BGR channel order stored in memory from high to low address
-    IPF_BGR_888 = 12,
+  /** 24bit with BGR channel order stored in memory from high to low address. */
+  IPF_BGR_888 = 12,
 
-    // 0:Black, 255:White
-    IPF_BINARY_8 = 13,
+  /** 0:Black, 255:White. */
+  IPF_BINARY_8 = 13,
 
-    IPF_NV12 = 14,
+  /** NV12. */
+  IPF_NV12 = 14,
 
-    // 0:white, 255:black.
-    IPF_BINARY_8_INVERTED = 15,
-}
+  /** 0:white, 255:black. */
+  IPF_BINARY_8_INVERTED = 15,
+}

package/src/core/ImageData.tsx

@@ -1,17 +1,57 @@
-import { EnumPixelFormat } from "./EnumPixelFormat";
+import {EnumPixelFormat} from "./EnumPixelFormat";
 import {NativeModules} from "react-native";
 
 declare global {
   function imageDataToBase64(imageData: ImageData): string; //Installed in ImageSourceAdapterModule
 }
 
+/**
+ * The ImageData interface represents image data, which contains the image bytes, width, height, stride, pixel format, orientation and a tag.
+ * <p>
+ * `Please release the imageData object when it is no longer needed. see` {@link ImageData.release}.
+ *
+ * If you want to display imagedata on react UI Element, you can use  {@link imageDataToBase64}
+ * @see ImageData.release
+ * @see imageDataToBase64
+ * @see EditorView.setOriginalImage
+ * @see ImageManager.saveToFile
+ * */
 export interface ImageData {
+  /**
+   * The raw bytes of the image, of type ArrayBuffer.
+   * @see ArrayBuffer
+   * */
   buffer: ArrayBuffer;
+
+  /**
+   * The width of the image in pixels.
+   * */
   width: number;
+
+  /**
+   * The height of the image in pixels.
+   * */
   height: number;
+
+  /**
+   * The stride (or row width) of the image in bytes.
+   * */
   stride: number;
+
+  /**
+   * The pixel format of the image.
+   * @see EnumPixelFormat
+   * */
   format: EnumPixelFormat | number;
+
+  /**
+   * The orientation information of the image.
+   * */
   orientation: number;
+
+  /**
+   * Release the native memory. Data cannot be used after release.
+   * */
   release(): void;
 }
 
@@ -19,17 +59,24 @@ export interface ImageData {
 const isTurboModuleEnabled = global.__turboModuleProxy != null;
 
 const ISAModule = isTurboModuleEnabled ?
-    require("./NativeDynamsoftImageSourceAdapterModule").default :
-    NativeModules.DynamsoftImageSourceAdapterModule
+  require("./NativeDynamsoftImageSourceAdapterModule").default :
+  NativeModules.DynamsoftImageSourceAdapterModule
 
 let isInstalled = false
 const installMethods = () => {
-  if(!isInstalled) {
+  if (!isInstalled) {
     ISAModule.install()
     isInstalled = true
   }
 }
 
+
+/**
+ * Converts an ImageData object to a Base64-encoded string.
+ *
+ * @param {ImageData} imageData - The ImageData object to convert.
+ * @returns {string} - The Base64-encoded string representation of the image data.
+ */
 export function imageDataToBase64(imageData: ImageData): string {
   installMethods();
   return global.imageDataToBase64(imageData);

package/src/core/ImageSourceAdapter.tsx

@@ -6,86 +6,146 @@ import type {EnumColourChannelUsageType} from "./EnumColourChannelUsageType";
 const isTurboModuleEnabled = global.__turboModuleProxy != null;
 
 const ISAModule = isTurboModuleEnabled ?
-    require("./NativeDynamsoftImageSourceAdapterModule").default :
-    NativeModules.DynamsoftImageSourceAdapterModule
+  require("./NativeDynamsoftImageSourceAdapterModule").default :
+  NativeModules.DynamsoftImageSourceAdapterModule
 
 let isInstalled = false
 const installMethods = () => {
-    if(!isInstalled) {
-        ISAModule.install()
-        isInstalled = true
-    }
+  if (!isInstalled) {
+    ISAModule.install()
+    isInstalled = true
+  }
 }
 
 declare global {
-    function isaAddImageToBuffer(nativeIsaId: string, imageData: ImageData): void;
+  function isaAddImageToBuffer(nativeIsaId: string, imageData: ImageData): void;
 
-    function isaGetImageData(nativeIsaId: string): ImageData | null | undefined;
+  function isaGetImageData(nativeIsaId: string): ImageData | null | undefined;
 }
 
+
+/**
+ * The ImageSourceAdapter class provides an interface for fetching and buffering images.
+ * It is an abstract class that needs to be implemented by a concrete class to provide actual functionality.
+ * `Each ImageSourceAdapter instance object will correspond to a native instance object.`
+ *
+ * @see CameraEnhancer
+ * @see CaptureVisionRouter.setInput
+ * */
 export abstract class ImageSourceAdapter {
-    protected isaId: string = "";
-
-    protected constructor() {
-        this.init();
-    }
-
-    protected init() {
-        this.isaId = ISAModule.createDefaultNativeISA();
-    }
-
-    /**@internal*/
-    public _getIsaId(): string {
-        return this.isaId;
-    }
-
-    public destroy(): void {
-        ISAModule.destroy(this.isaId);
-    }
-
-    public addImageToBuffer(imageData: ImageData): void {
-        installMethods()
-        global.isaAddImageToBuffer(this.isaId, imageData)
-    }
-
-    public getImageData(): ImageData | null | undefined {
-        installMethods()
-        return global.isaGetImageData(this.isaId)
-    }
-
-    public getImageCount(): Promise<number> {
-        return ISAModule.getImageCount(this.isaId);
-    }
-
-    public isBufferEmpty(): Promise<boolean> {
-        return ISAModule.isBufferEmpty(this.isaId);
-    }
-
-    public clearBuffer(): Promise<void> {
-        return ISAModule.clearBuffer(this.isaId);
-    }
-
-    public getColourChannelUsageType(): Promise<EnumColourChannelUsageType> {
-        return ISAModule.getColourChannelUsageType(this.isaId);
-    }
-
-    public setColourChannelUsageType(type: EnumColourChannelUsageType): Promise<void> {
-        return ISAModule.setColourChannelUsageType(this.isaId, type);
-    }
-
-    public getMaximumImageCount(): Promise<number> {
-        return ISAModule.getMaximumImageCount(this.isaId);
-    }
-
-    public setMaximumImageCount(count: number): Promise<void> {
-        return ISAModule.setNextImageToReturn(this.isaId, count);
-    }
-
-    public startFetching(): void {
-        ISAModule.startFetching(this.isaId);
-    }
-
-    public stopFetching(): void {
-        ISAModule.stopFetching(this.isaId);
-    }
+  protected isaId: string = "";
+
+  protected constructor() {
+    this.init();
+  }
+
+  protected init() {
+    this.isaId = ISAModule.createDefaultNativeISA();
+  }
+
+  /**@internal*/
+  public _getIsaId(): string {
+    return this.isaId;
+  }
+
+  /**
+   * Destroy native instance. This object is no longer available after destroy().
+   * */
+  public destroy(): void {
+    ISAModule.destroy(this.isaId);
+  }
+
+  /**
+   * Adds an image to the buffer of the adapter.
+   *
+   * @param imageData The {@link ImageData} object to be added to the buffer.
+   * */
+  public addImageToBuffer(imageData: ImageData): void {
+    installMethods()
+    global.isaAddImageToBuffer(this.isaId, imageData)
+  }
+
+  /**
+   * Get a buffered image.
+   *
+   * @returns {ImageData|null|undefined} - The {@link ImageData} object if available, otherwise`null` or `undefined` if no image is found in the buffer.
+   * */
+  public getImageData(): ImageData | null | undefined {
+    installMethods()
+    return global.isaGetImageData(this.isaId)
+  }
+
+  /**
+  * Get the current number of images in the buffer.
+  *
+  * @returns {Promise<number>} - A promise that resolves to the number of images in the buffer.
+  * */
+  public getImageCount(): Promise<number> {
+    return ISAModule.getImageCount(this.isaId);
+  }
+
+  /**
+   * Determines whether the buffer is empty.
+   * */
+  public isBufferEmpty(): Promise<boolean> {
+    return ISAModule.isBufferEmpty(this.isaId);
+  }
+
+  /**
+   * Clear the image buffer.
+   * */
+  public clearBuffer(): Promise<void> {
+    return ISAModule.clearBuffer(this.isaId);
+  }
+
+
+  /**
+   *  Get the current usage type for color channels in images.
+   *
+   * @returns {Promise<EnumColourChannelUsageType>} - A promise that resolves to an enum representing the color channel usage type.
+   * */
+  public getColourChannelUsageType(): Promise<EnumColourChannelUsageType> {
+    return ISAModule.getColourChannelUsageType(this.isaId);
+  }
+
+  /**
+   * Set the usage type of a color channel in images.
+   *
+   * @param type The usage type({@link EnumColourChannelUsageType}) to be set for the color channel.
+   * */
+  public setColourChannelUsageType(type: EnumColourChannelUsageType): Promise<void> {
+    return ISAModule.setColourChannelUsageType(this.isaId, type);
+  }
+
+  /**
+   * Get the maximum number of images that can be buffered.
+   *
+   * @return {Promise<number>} - A promise that resolves to the maximum capability of the Buffer.
+   * */
+  public getMaximumImageCount(): Promise<number> {
+    return ISAModule.getMaximumImageCount(this.isaId);
+  }
+
+  /**
+   * Set the maximum number of images that can be buffered at any time.
+   *
+   * @param count - The maximum capability of the Buffer.
+   * */
+  public setMaximumImageCount(count: number): Promise<void> {
+    return ISAModule.setNextImageToReturn(this.isaId, count);
+  }
+
+  /**
+   * Start fetching images from the source to the Buffer of ImageSourceAdapter.
+   * */
+  public startFetching(): void {
+    ISAModule.startFetching(this.isaId);
+  }
+
+  /**
+   * Stop fetching images from the source to the Buffer of ImageSourceAdapter.
+   * */
+  public stopFetching(): void {
+    ISAModule.stopFetching(this.isaId);
+  }
 }

package/src/core/NativeDynamsoftImageSourceAdapterModule.tsx

@@ -1,18 +1,29 @@
-import {type TurboModule, TurboModuleRegistry } from "react-native";
+import {type TurboModule, TurboModuleRegistry} from "react-native";
 
 export interface Spec extends TurboModule {
-    install():boolean;
-    createDefaultNativeISA(): string;
-    destroy(isaId:string): void;
-    getImageCount(isaId:string): Promise<number>;
-    isBufferEmpty(isaId:string): Promise<boolean>;
-    clearBuffer(isaId:string): Promise<void>;
-    getColourChannelUsageType(isaId:string): Promise<number>;
-    setColourChannelUsageType(isaId:string, type: number): Promise<void>;
-    getMaximumImageCount(isaId:string): Promise<number>;
-    setMaximumImageCount(isaId:string, maxCount:number): Promise<void>;
-    startFetching(isaId:string): void;
-    stopFetching(isaId:string): void;
+  install(): boolean;
+
+  createDefaultNativeISA(): string;
+
+  destroy(isaId: string): void;
+
+  getImageCount(isaId: string): Promise<number>;
+
+  isBufferEmpty(isaId: string): Promise<boolean>;
+
+  clearBuffer(isaId: string): Promise<void>;
+
+  getColourChannelUsageType(isaId: string): Promise<number>;
+
+  setColourChannelUsageType(isaId: string, type: number): Promise<void>;
+
+  getMaximumImageCount(isaId: string): Promise<number>;
+
+  setMaximumImageCount(isaId: string, maxCount: number): Promise<void>;
+
+  startFetching(isaId: string): void;
+
+  stopFetching(isaId: string): void;
 }
 
 export default TurboModuleRegistry.get<Spec>("DynamsoftImageSourceAdapterModule") as Spec | null;

package/src/core/Point.tsx

@@ -1,10 +1,13 @@
+/**
+* @see Quadrilateral.points
+* */
 export interface Point {
-    /**
-     * X coordinate of the point.
-     */
-    x:number;
-    /**
-     * Y coordinate of the point.
-     */
-    y:number;
-}
+  /**
+   * X coordinate of the point.
+   */
+  x: number;
+  /**
+   * Y coordinate of the point.
+   */
+  y: number;
+}

package/src/core/Quadrilateral.tsx

@@ -1,8 +1,12 @@
 import type {Point} from "./Point";
 
+/**
+ * The Quadrilateral class represents a quadrilateral shape in 2D space,
+ * which contains an array of four points, representing the vertices of the quadrilateral.
+ * */
 export interface Quadrilateral {
-    /**
-     * Vertex coordinates of the quadrilateral.
-     */
-    points : Point[];
-}
+  /**
+   * Vertex coordinates of the quadrilateral.
+   */
+  points: Point[];
+}

package/src/core/Rect.tsx

@@ -1,18 +1,21 @@
+/**
+ * @see TorchButton.location
+ * */
 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;
+  /**
+   * 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;
 }