assistsx-js 0.0.2035 → 0.0.2037

package/dist/AssistsXAsync.d.ts

@@ -7,6 +7,37 @@ import { Bounds } from "./Bounds";
 import { AppInfo } from "./AppInfo";
 import { DeviceInfo } from "./DeviceInfo";
 import { WebFloatingWindowOptions } from "./AssistsX";
+/**
+ * 截图识别位置信息
+ */
+export interface RecognizeTextInScreenshotPosition {
+    text: string;
+    left: number;
+    top: number;
+    right: number;
+    bottom: number;
+    width: number;
+    height: number;
+}
+/**
+ * 截图识别结果
+ */
+export interface RecognizeTextInScreenshotResult {
+    fullText: string;
+    processingTimeMillis: number;
+    positions: RecognizeTextInScreenshotPosition[];
+}
+/**
+ * 截图识别区域参数
+ */
+export interface RecognizeTextRegion {
+    left?: number;
+    top?: number;
+    right?: number;
+    bottom?: number;
+    width?: number;
+    height?: number;
+}
 export declare class AssistsXAsync {
     /**
      * 执行异步调用
@@ -62,6 +93,19 @@ export declare class AssistsXAsync {
      * @returns 截图路径数组
      */
     static takeScreenshotNodes(nodes: Node[], overlayHiddenScreenshotDelayMillis?: number, timeout?: number): Promise<string[]>;
+    /**
+     * 截图识别文本
+     * @param param0 识别参数
+     * @returns 截图识别结果
+     */
+    static recognizeTextInScreenshot({ targetText, rotationDegrees, overlayHiddenScreenshotDelayMillis, restoreOverlay, region, timeout, }: {
+        targetText: string;
+        rotationDegrees?: number;
+        overlayHiddenScreenshotDelayMillis?: number;
+        restoreOverlay?: boolean;
+        region?: RecognizeTextRegion;
+        timeout?: number;
+    }): Promise<RecognizeTextInScreenshotResult>;
     static scanQR(timeout?: number): Promise<string>;
     static loadWebViewOverlay(url: string, options?: WebFloatingWindowOptions & {
         timeout?: number;
@@ -381,6 +425,12 @@ export declare class AssistsXAsync {
      */
     static openUrlInBrowser(url: string, timeout?: number): Promise<boolean>;
     static download(url: string, timeout?: number): Promise<string | null | undefined>;
-    static audioPlayFromFile(filePath: string, volume?: number | undefined, timeout?: number): Promise<string | null | undefined>;
-    static audioStop(timeout?: number): Promise<boolean | null | undefined>;
+    static audioPlayFromFile(filePath: string, { volume, useAbsoluteVolume, timeout, }: {
+        volume?: number;
+        useAbsoluteVolume?: boolean;
+        timeout?: number;
+    }): Promise<string | null | undefined>;
+    static audioStop({ timeout, }: {
+        timeout?: number;
+    }): Promise<boolean | null | undefined>;
 }

package/dist/AssistsXAsync.js

@@ -119,6 +119,28 @@ export class AssistsXAsync {
         const data = response.getDataOrDefault("");
         return data.images;
     }
+    /**
+     * 截图识别文本
+     * @param param0 识别参数
+     * @returns 截图识别结果
+     */
+    static async recognizeTextInScreenshot({ targetText, rotationDegrees, overlayHiddenScreenshotDelayMillis, restoreOverlay = true, region, timeout, }) {
+        const response = await this.asyncCall(CallMethod.recognizeTextInScreenshot, {
+            args: {
+                targetText,
+                rotationDegrees,
+                overlayHiddenScreenshotDelayMillis,
+                restoreOverlay,
+                region,
+            },
+            timeout,
+        });
+        return response.getDataOrDefault({
+            fullText: "",
+            processingTimeMillis: 0,
+            positions: [],
+        });
+    }
     static async scanQR(timeout) {
         const response = await this.asyncCall(CallMethod.scanQR, { timeout });
         const data = response.getDataOrDefault({ value: "" });
@@ -645,14 +667,14 @@ export class AssistsXAsync {
         });
         return response.getDataOrDefault(null);
     }
-    static async audioPlayFromFile(filePath, volume = undefined, timeout) {
+    static async audioPlayFromFile(filePath, { volume = undefined, useAbsoluteVolume = false, timeout = 30, }) {
         const response = await this.asyncCall(CallMethod.audioPlayFromFile, {
-            args: { filePath, volume },
+            args: { filePath, volume, useAbsoluteVolume },
             timeout,
         });
         return response.getDataOrDefault(null);
     }
-    static async audioStop(timeout) {
+    static async audioStop({ timeout = 30, }) {
         const response = await this.asyncCall(CallMethod.audioStop, {
             timeout,
         });

package/dist/CallMethod.d.ts

@@ -33,6 +33,7 @@ export declare const CallMethod: {
     readonly setOverlayFlags: "setOverlayFlags";
     readonly scanQR: "scanQR";
     readonly loadWebViewOverlay: "loadWebViewOverlay";
+    readonly recognizeTextInScreenshot: "recognizeTextInScreenshot";
     readonly clickByGesture: "clickByGesture";
     readonly clickNodeByGesture: "clickNodeByGesture";
     readonly doubleClickNodeByGesture: "doubleClickNodeByGesture";

package/dist/CallMethod.js

@@ -34,6 +34,7 @@ export const CallMethod = {
     setOverlayFlags: "setOverlayFlags",
     scanQR: "scanQR",
     loadWebViewOverlay: "loadWebViewOverlay",
+    recognizeTextInScreenshot: "recognizeTextInScreenshot",
     clickByGesture: "clickByGesture",
     clickNodeByGesture: "clickNodeByGesture",
     doubleClickNodeByGesture: "doubleClickNodeByGesture",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assistsx-js",
-  "version": "0.0.2035",
+  "version": "0.0.2037",
   "description": "assistsx-js自动化开发SDK",
   "main": "dist/index.js",
   "module": "dist/index.js",

package/src/AssistsXAsync.ts

@@ -17,6 +17,40 @@ import {
   HttpResponse,
 } from "./AssistsX";
 
+/**
+ * 截图识别位置信息
+ */
+export interface RecognizeTextInScreenshotPosition {
+  text: string;
+  left: number;
+  top: number;
+  right: number;
+  bottom: number;
+  width: number;
+  height: number;
+}
+
+/**
+ * 截图识别结果
+ */
+export interface RecognizeTextInScreenshotResult {
+  fullText: string;
+  processingTimeMillis: number;
+  positions: RecognizeTextInScreenshotPosition[];
+}
+
+/**
+ * 截图识别区域参数
+ */
+export interface RecognizeTextRegion {
+  left?: number;
+  top?: number;
+  right?: number;
+  bottom?: number;
+  width?: number;
+  height?: number;
+}
+
 export class AssistsXAsync {
   /**
    * 执行异步调用
@@ -167,6 +201,45 @@ export class AssistsXAsync {
     const data = response.getDataOrDefault("");
     return data.images;
   }
+  /**
+   * 截图识别文本
+   * @param param0 识别参数
+   * @returns 截图识别结果
+   */
+  public static async recognizeTextInScreenshot({
+    targetText,
+    rotationDegrees,
+    overlayHiddenScreenshotDelayMillis,
+    restoreOverlay = true,
+    region,
+    timeout,
+  }: {
+    targetText: string;
+    rotationDegrees?: number;
+    overlayHiddenScreenshotDelayMillis?: number;
+    restoreOverlay?: boolean;
+    region?: RecognizeTextRegion;
+    timeout?: number;
+  }): Promise<RecognizeTextInScreenshotResult> {
+    const response = await this.asyncCall(
+      CallMethod.recognizeTextInScreenshot,
+      {
+        args: {
+          targetText,
+          rotationDegrees,
+          overlayHiddenScreenshotDelayMillis,
+          restoreOverlay,
+          region,
+        },
+        timeout,
+      }
+    );
+    return response.getDataOrDefault({
+      fullText: "",
+      processingTimeMillis: 0,
+      positions: [],
+    });
+  }
   public static async scanQR(timeout?: number): Promise<string> {
     const response = await this.asyncCall(CallMethod.scanQR, { timeout });
     const data = response.getDataOrDefault({ value: "" });
@@ -927,18 +1000,27 @@ export class AssistsXAsync {
   }
   public static async audioPlayFromFile(
     filePath: string,
-    volume: number | undefined = undefined,
-    timeout?: number
+    {
+      volume = undefined,
+      useAbsoluteVolume = false,
+      timeout = 30,
+    }: {
+      volume?: number;
+      useAbsoluteVolume?: boolean;
+      timeout?: number;
+    }
   ): Promise<string | null | undefined> {
     const response = await this.asyncCall(CallMethod.audioPlayFromFile, {
-      args: { filePath, volume },
+      args: { filePath, volume, useAbsoluteVolume },
       timeout,
     });
     return response.getDataOrDefault(null);
   }
-  public static async audioStop(
-    timeout?: number
-  ): Promise<boolean | null | undefined> {
+  public static async audioStop({
+    timeout = 30,
+  }: {
+    timeout?: number;
+  }): Promise<boolean | null | undefined> {
     const response = await this.asyncCall(CallMethod.audioStop, {
       timeout,
     });

package/src/CallMethod.ts

@@ -34,6 +34,7 @@ export const CallMethod = {
   setOverlayFlags: "setOverlayFlags",
   scanQR: "scanQR",
   loadWebViewOverlay: "loadWebViewOverlay",
+  recognizeTextInScreenshot: "recognizeTextInScreenshot",
 
   clickByGesture: "clickByGesture",
   clickNodeByGesture: "clickNodeByGesture",