dynamsoft-capture-vision-react-native 3.4.1200 → 3.4.3000

package/src/core/EnumPixelFormat.tsx

@@ -1,53 +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 {@link ImageData.format}
- * */
-export enum EnumPixelFormat {
-  /** 0:Black, 1:White. */
-  IPF_BINARY = 0,
-
-  /** 0:White, 1:Black. */
-  IPF_BINARYINVERTED = 1,
-
-  /** 8bit gray. */
-  IPF_GRAYSCALED = 2,
-
-  /** 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_555 = 5,
-
-  /** 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,
-
-  /** 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,
-
-  /** 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,
-
-  /** 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,
-
-  /** NV12. */
-  IPF_NV12 = 14,
-
-  /** 0:white, 255:black. */
-  IPF_BINARY_8_INVERTED = 15,
-}
+/**
+ * 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 {@link ImageData.format}
+ * */
+export enum EnumPixelFormat {
+  /** 0:Black, 1:White. */
+  IPF_BINARY = 0,
+
+  /** 0:White, 1:Black. */
+  IPF_BINARYINVERTED = 1,
+
+  /** 8bit gray. */
+  IPF_GRAYSCALED = 2,
+
+  /** 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_555 = 5,
+
+  /** 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,
+
+  /** 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,
+
+  /** 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,
+
+  /** 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,
+
+  /** NV12. */
+  IPF_NV12 = 14,
+
+  /** 0:white, 255:black. */
+  IPF_BINARY_8_INVERTED = 15,
+}

package/src/core/ImageData.tsx

@@ -1,87 +1,87 @@
-import {EnumPixelFormat} from "./EnumPixelFormat";
-import {NativeModules} from "react-native";
-import {ImageEditorView} from "../dce";
-import {ImageManager} from "../utility";
-import {IntermediateResultManager} from "../cvr";
-
-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 {@link imageDataToBase64}
- * @see {@link ImageEditorView.setOriginalImage}
- * @see {@link ImageManager.saveToFile}
- * */
-export interface ImageData {
-  /**
-   * The raw bytes of the image, of type {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer 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, of type {@link EnumPixelFormat}
-   * */
-  format: EnumPixelFormat | number;
-
-  /**
-   * The orientation information of the image.
-   * */
-  orientation: number;
-
-  /**
-   * Release the native memory. Data cannot be used after release.
-   * */
-  release(): void;
-}
-
-// @ts-ignore Check whether __turboModuleProxy exists, it may not
-const isTurboModuleEnabled = global.__turboModuleProxy != null;
-
-const ISAModule = isTurboModuleEnabled ?
-  require("./NativeDynamsoftImageSourceAdapterModule").default :
-  NativeModules.DynamsoftImageSourceAdapterModule
-
-let isInstalled = false
-const installMethods = () => {
-  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.
- * @see {@link IntermediateResultManager.getOriginalImage}
- */
-export function imageDataToBase64(imageData: ImageData): string | undefined | null {
-  installMethods();
-  if (typeof global.imageDataToBase64 !== 'function') {
-    return null;
-  }
-  return global.imageDataToBase64(imageData);
-}
+import {EnumPixelFormat} from "./EnumPixelFormat";
+import {NativeModules} from "react-native";
+import {ImageEditorView} from "../dce";
+import {ImageManager} from "../utility";
+import {IntermediateResultManager} from "../cvr";
+
+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 {@link imageDataToBase64}
+ * @see {@link ImageEditorView.setOriginalImage}
+ * @see {@link ImageManager.saveToFile}
+ * */
+export interface ImageData {
+  /**
+   * The raw bytes of the image, of type {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer 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, of type {@link EnumPixelFormat}
+   * */
+  format: EnumPixelFormat | number;
+
+  /**
+   * The orientation information of the image.
+   * */
+  orientation: number;
+
+  /**
+   * Release the native memory. Data cannot be used after release.
+   * */
+  release(): void;
+}
+
+// @ts-ignore Check whether __turboModuleProxy exists, it may not
+const isTurboModuleEnabled = global.__turboModuleProxy != null;
+
+const ISAModule = isTurboModuleEnabled ?
+  require("./NativeDynamsoftImageSourceAdapterModule").default :
+  NativeModules.DynamsoftImageSourceAdapterModule
+
+let isInstalled = false
+const installMethods = () => {
+  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.
+ * @see {@link IntermediateResultManager.getOriginalImage}
+ */
+export function imageDataToBase64(imageData: ImageData): string | undefined | null {
+  installMethods();
+  if (typeof global.imageDataToBase64 !== 'function') {
+    return null;
+  }
+  return global.imageDataToBase64(imageData);
+}

package/src/core/ImageSourceAdapter.tsx

@@ -1,160 +1,160 @@
-import type {ImageData} from "./ImageData";
-import {NativeModules} from "react-native";
-import type {EnumColourChannelUsageType} from "./EnumColourChannelUsageType";
-import {CameraEnhancer} from "../dce";
-import {CaptureVisionRouter} from "../cvr";
-
-// @ts-ignore Check whether __turboModuleProxy exists, it may not
-const isTurboModuleEnabled = global.__turboModuleProxy != null;
-
-const ISAModule = isTurboModuleEnabled ?
-  require("./NativeDynamsoftImageSourceAdapterModule").default :
-  NativeModules.DynamsoftImageSourceAdapterModule
-
-let isInstalled = false
-const installMethods = () => {
-  if (!isInstalled) {
-    ISAModule.install()
-    isInstalled = true
-  }
-}
-
-declare global {
-  function isaAddImageToBuffer(nativeIsaId: string, imageData: ImageData): void;
-
-  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 {@link CameraEnhancer}
- * @see {@link CaptureVisionRouter.setInput}
- * @hideconstructor
- * */
-export abstract class ImageSourceAdapter {
-  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()
-    if (typeof global.isaAddImageToBuffer !== 'function') {
-      return;
-    }
-    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()
-    if (typeof global.isaGetImageData !== 'function') {
-      return null;
-    }
-    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);
-  }
-}
+import type {ImageData} from "./ImageData";
+import {NativeModules} from "react-native";
+import type {EnumColourChannelUsageType} from "./EnumColourChannelUsageType";
+import {CameraEnhancer} from "../dce";
+import {CaptureVisionRouter} from "../cvr";
+
+// @ts-ignore Check whether __turboModuleProxy exists, it may not
+const isTurboModuleEnabled = global.__turboModuleProxy != null;
+
+const ISAModule = isTurboModuleEnabled ?
+  require("./NativeDynamsoftImageSourceAdapterModule").default :
+  NativeModules.DynamsoftImageSourceAdapterModule
+
+let isInstalled = false
+const installMethods = () => {
+  if (!isInstalled) {
+    ISAModule.install()
+    isInstalled = true
+  }
+}
+
+declare global {
+  function isaAddImageToBuffer(nativeIsaId: string, imageData: ImageData): void;
+
+  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 {@link CameraEnhancer}
+ * @see {@link CaptureVisionRouter.setInput}
+ * @hideconstructor
+ * */
+export abstract class ImageSourceAdapter {
+  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()
+    if (typeof global.isaAddImageToBuffer !== 'function') {
+      return;
+    }
+    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()
+    if (typeof global.isaGetImageData !== 'function') {
+      return null;
+    }
+    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,29 +1,29 @@
-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;
-}
-
-export default TurboModuleRegistry.get<Spec>("DynamsoftImageSourceAdapterModule") as Spec | null;
+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;
+}
+
+export default TurboModuleRegistry.get<Spec>("DynamsoftImageSourceAdapterModule") as Spec | null;