ms-types 0.4.13 → 0.4.15

package/types/tomatoocr.d.ts

@@ -1,209 +1,209 @@
-/**
- * TomatoOCR 模块
- * 提供基于 TomatoOCR 框架的文字识别和 YOLO 目标检测功能
- */
-declare namespace tomatoOcr {
-  /**
-   * 初始化TomatoOCR并设置基本配置
-   * @param mode 运行模式 debug：调试模型；删除或传别的任何值为正式模式
-   * @param licenseData 授权码 请传入你在 TomatoOCR 官网申请的授权码
-   * @param remark 备注信息（可选）
-   * @returns 设置结果
-   * @example
-   * ```typescript
-   * // 不带备注
-   * const result1 = tomatoOcr.initializeWithConfig("online", "授权码");
-   * // 带备注
-   * const result2 = tomatoOcr.initializeWithConfig("online", "授权码", "测试环境");
-   * logi(result1, result2);
-   * ```
-   */
-  function initializeWithConfig(
-    mode: string,
-    licenseData: string,
-    remark?: string
-  ): {
-    deviceId: string;
-    expiryTime: string;
-    message: string;
-    status: string;
-    versionName: string;
-  } | null;
-
-  /**
-   * 设置 HTTP 请求间隔时间
-   * @param second 间隔秒数 设置网络请求间隔时间，非必设置。0-86400
-   * @example
-   * ```typescript
-   * tomatoOcr.setHttpIntervalTime(3600);
-   * ```
-   */
-  function setHttpIntervalTime(second: number): void;
-
-  /**
-   * 设置识别类型
-   * @param recType 识别类型 模型类型,默认 ch-3.0,除此之外还有 ch-2.0, ch, cht, japan, korean, number
-   * @example
-   * ```typescript
-   * // 普通中英文识别，3.0版模型
-   * tomatoOcr.setRecType("ch-3.0");
-   * // 普通中英文识别，2.0版模型
-   * tomatoOcr.setRecType("ch-2.0");
-   * // 普通中英文识别，1.0版模型
-   * tomatoOcr.setRecType("ch");
-   * // 繁体
-   * tomatoOcr.setRecType("cht");
-   * // 日语
-   * tomatoOcr.setRecType("japan");
-   * // 韩语
-   * tomatoOcr.setRecType("korean");
-   * // 数字模型
-   * tomatoOcr.setRecType("number");
-   * ```
-   */
-  function setRecType(recType: string): void;
-
-  /**
-   * 设置检测框类型
-   * @param detBoxType 检测框类型 默认"rect": 由于手机上截图文本均为矩形文本；"quad"：可准确检测倾斜文本
-   * @example
-   * ```typescript
-   * // 矩形文本
-   * tomatoOcr.setDetBoxType("rect");
-   * // 倾斜文本
-   * tomatoOcr.setDetBoxType("quad");
-   * ```
-   */
-  function setDetBoxType(detBoxType: string): void;
-
-  /**
-   * 设置检测框展开比例
-   * @param detUnclipRatio 设置检测模型框选文本范围大小的参数，非必设置，默认为1.9。值范围1.6-2.5之间，值越大框选范围越大，值越小框选范围越小；当框选到了，但识别得分较低，就可以调整该参数改善准确率。
-   * @example
-   * ```typescript
-   * tomatoOcr.setDetUnclipRatio(1.9);
-   * ```
-   */
-  function setDetUnclipRatio(detUnclipRatio: number): void;
-
-  /**
-   * 设置检测框缩放比例
-   * @param detScaleRatio 检测框缩放比例
-   * @example
-   * ```typescript
-   * tomatoOcr.setDetScaleRatio(1.2);
-   * ```
-   */
-  function setDetScaleRatio(detScaleRatio: number): void;
-
-  /**
-   * 设置识别分数阈值
-   * @param recScoreThreshold 设置识别模型过滤得分的参数，非必设置，默认0.1。由于返回的识别结果数据太多太乱，可以通过设置该参数，过滤一些得分较低不准的数据，使得结果看起来更加简练。
-   * @example
-   * ```typescript
-   * tomatoOcr.setRecScoreThreshold(0.1);
-   * ```
-   */
-  function setRecScoreThreshold(recScoreThreshold: number): void;
-
-  /**
-   * 设置返回类型
-   * @param returnType 设置调用插件识别返回格式的参数，非必设置，默认为json。默认"json": 包含得分、坐标和文字；"text"：纯文字；"num"：纯数字；自定义输入想要返回的文本：".￥1234567890"，仅只返回这些内容
-   * @example
-   * ```typescript
-   * tomatoOcr.setReturnType("json");
-   * ```
-   */
-  function setReturnType(returnType: string): void;
-
-  /**
-   * 设置二值化阈值
-   * @param binaryThresh 设置图像二值化的参数，非必设置，默认0，不进行二值化。 二值化设定0-255，常规情况下不需要设置，可配合中调试应用使用。
-   * @example
-   * ```typescript
-   * tomatoOcr.setBinaryThresh(0);
-   * ```
-   */
-  function setBinaryThresh(binaryThresh: number): void;
-
-  /**
-   * 设置运行模式
-   * @param runMode 运行模式
-   * @example
-   * ```typescript
-   * tomatoOcr.setRunMode("fast");
-   * ```
-   */
-  function setRunMode(runMode: string): void;
-
-  /**
-   * 设置图像滤色参数，非必设置，默认""，对图片中的文字进行颜色过滤，可以是单色也可以为多色，配合调试工具使用，如下图：
-   * @param filterColor 颜色过滤，通过逗号相互连，第一个是颜色值，第二个是负偏色，第三个是正偏色；不同颜色之间以"|"连接
-   * @param backgroundColor 滤色后的背景色，传""或black的时候，背景是黑色，传“white”的时候，背景是白色
-   * @example
-   * ```typescript
-   * tomatoOcr.setFilterColor("#41917A,38,38", "black");
-   * tomatoOcr.setFilterColor("#41917A,38,38|#E091A8,50,50", "white");
-   * ```
-   */
-  function setFilterColor(filterColor: string, backgroundColor: string): void;
-
-  /**
-   * 对图像执行 OCR 识别
-   * @param input 输入源（imageId、URL字符串、文件路径或"screen"，"screen"表示使用当前屏幕）
-   * @param type 识别类型 默认3: 检测 + 识别；0: 只检测；1: 方向分类+识别；2: 只识别；3: 检测+识别
-   * @param x 边界框左上角x坐标
-   * @param y 边界框左上角y坐标
-   * @param ex 边界框右下角x坐标
-   * @param ey 边界框右下角y坐标
-   * @returns OCR识别结果JSON字符串
-   * @example
-   * ```typescript
-   * // 识别屏幕
-   * const result1 = tomatoOcr.ocrImage("screen", 0, 0, 0, 0, 0);
-   * logi(`识别屏幕结果：${result1}`);
-   *
-   * // 识别文件
-   * const result2 = tomatoOcr.ocrImage("/path/to/image.png", 0);
-   * logi(`识别文件结果：${result2}`);
-   *
-   * // 识别指定屏幕区域
-   * const result3 = tomatoOcr.ocrImage("screen", 0);
-   * logi(`识别指定屏幕区域结果：${result3}`);
-   * ```
-   */
-  function ocrImage(
-    input: string,
-    type: number,
-    x?: number,
-    y?: number,
-    ex?: number,
-    ey?: number
-  ): string;
-
-  /**
-   * 查找点击点
-   * @param data 要找的文字
-   * @returns 找“要找的文字”的中心点 没有找到返回空字符串
-   * @example
-   * ```typescript
-   * const result = tomatoOcr.findTapPoint('{"text": "确定"}');
-   * const tapPoint = JSON.parse(result);
-   * logi(tapPoint);
-   * ```
-   */
-  function findTapPoint(data: string): string;
-
-  /**
-   * 查找多个点击点
-   * @param data 要找的文字
-   * @returns 找“要找的文字”的所有相匹配的中心点 没有找到返回空字符串
-   * @example
-   * ```typescript
-   * const result = tomatoOcr.findTapPoints('{"texts": ["确定", "取消"]}');
-   * const tapPoints = JSON.parse(result);
-   * logi(tapPoints);
-   * ```
-   */
-  function findTapPoints(data: string): string;
-}
+/**
+ * TomatoOCR 模块
+ * 提供基于 TomatoOCR 框架的文字识别和 YOLO 目标检测功能
+ */
+declare namespace tomatoOcr {
+  /**
+   * 初始化TomatoOCR并设置基本配置
+   * @param mode 运行模式 debug：调试模型；删除或传别的任何值为正式模式
+   * @param licenseData 授权码 请传入你在 TomatoOCR 官网申请的授权码
+   * @param remark 备注信息（可选）
+   * @returns 设置结果
+   * @example
+   * ```typescript
+   * // 不带备注
+   * const result1 = tomatoOcr.initializeWithConfig("online", "授权码");
+   * // 带备注
+   * const result2 = tomatoOcr.initializeWithConfig("online", "授权码", "测试环境");
+   * logi(result1, result2);
+   * ```
+   */
+  function initializeWithConfig(
+    mode: string,
+    licenseData: string,
+    remark?: string
+  ): {
+    deviceId: string;
+    expiryTime: string;
+    message: string;
+    status: string;
+    versionName: string;
+  } | null;
+
+  /**
+   * 设置 HTTP 请求间隔时间
+   * @param second 间隔秒数 设置网络请求间隔时间，非必设置。0-86400
+   * @example
+   * ```typescript
+   * tomatoOcr.setHttpIntervalTime(3600);
+   * ```
+   */
+  function setHttpIntervalTime(second: number): void;
+
+  /**
+   * 设置识别类型
+   * @param recType 识别类型 模型类型,默认 ch-3.0,除此之外还有 ch-2.0, ch, cht, japan, korean, number
+   * @example
+   * ```typescript
+   * // 普通中英文识别，3.0版模型
+   * tomatoOcr.setRecType("ch-3.0");
+   * // 普通中英文识别，2.0版模型
+   * tomatoOcr.setRecType("ch-2.0");
+   * // 普通中英文识别，1.0版模型
+   * tomatoOcr.setRecType("ch");
+   * // 繁体
+   * tomatoOcr.setRecType("cht");
+   * // 日语
+   * tomatoOcr.setRecType("japan");
+   * // 韩语
+   * tomatoOcr.setRecType("korean");
+   * // 数字模型
+   * tomatoOcr.setRecType("number");
+   * ```
+   */
+  function setRecType(recType: string): void;
+
+  /**
+   * 设置检测框类型
+   * @param detBoxType 检测框类型 默认"rect": 由于手机上截图文本均为矩形文本；"quad"：可准确检测倾斜文本
+   * @example
+   * ```typescript
+   * // 矩形文本
+   * tomatoOcr.setDetBoxType("rect");
+   * // 倾斜文本
+   * tomatoOcr.setDetBoxType("quad");
+   * ```
+   */
+  function setDetBoxType(detBoxType: string): void;
+
+  /**
+   * 设置检测框展开比例
+   * @param detUnclipRatio 设置检测模型框选文本范围大小的参数，非必设置，默认为1.9。值范围1.6-2.5之间，值越大框选范围越大，值越小框选范围越小；当框选到了，但识别得分较低，就可以调整该参数改善准确率。
+   * @example
+   * ```typescript
+   * tomatoOcr.setDetUnclipRatio(1.9);
+   * ```
+   */
+  function setDetUnclipRatio(detUnclipRatio: number): void;
+
+  /**
+   * 设置检测框缩放比例
+   * @param detScaleRatio 检测框缩放比例
+   * @example
+   * ```typescript
+   * tomatoOcr.setDetScaleRatio(1.2);
+   * ```
+   */
+  function setDetScaleRatio(detScaleRatio: number): void;
+
+  /**
+   * 设置识别分数阈值
+   * @param recScoreThreshold 设置识别模型过滤得分的参数，非必设置，默认0.1。由于返回的识别结果数据太多太乱，可以通过设置该参数，过滤一些得分较低不准的数据，使得结果看起来更加简练。
+   * @example
+   * ```typescript
+   * tomatoOcr.setRecScoreThreshold(0.1);
+   * ```
+   */
+  function setRecScoreThreshold(recScoreThreshold: number): void;
+
+  /**
+   * 设置返回类型
+   * @param returnType 设置调用插件识别返回格式的参数，非必设置，默认为json。默认"json": 包含得分、坐标和文字；"text"：纯文字；"num"：纯数字；自定义输入想要返回的文本：".￥1234567890"，仅只返回这些内容
+   * @example
+   * ```typescript
+   * tomatoOcr.setReturnType("json");
+   * ```
+   */
+  function setReturnType(returnType: string): void;
+
+  /**
+   * 设置二值化阈值
+   * @param binaryThresh 设置图像二值化的参数，非必设置，默认0，不进行二值化。 二值化设定0-255，常规情况下不需要设置，可配合中调试应用使用。
+   * @example
+   * ```typescript
+   * tomatoOcr.setBinaryThresh(0);
+   * ```
+   */
+  function setBinaryThresh(binaryThresh: number): void;
+
+  /**
+   * 设置运行模式
+   * @param runMode 运行模式
+   * @example
+   * ```typescript
+   * tomatoOcr.setRunMode("fast");
+   * ```
+   */
+  function setRunMode(runMode: string): void;
+
+  /**
+   * 设置图像滤色参数，非必设置，默认""，对图片中的文字进行颜色过滤，可以是单色也可以为多色，配合调试工具使用，如下图：
+   * @param filterColor 颜色过滤，通过逗号相互连，第一个是颜色值，第二个是负偏色，第三个是正偏色；不同颜色之间以"|"连接
+   * @param backgroundColor 滤色后的背景色，传""或black的时候，背景是黑色，传“white”的时候，背景是白色
+   * @example
+   * ```typescript
+   * tomatoOcr.setFilterColor("#41917A,38,38", "black");
+   * tomatoOcr.setFilterColor("#41917A,38,38|#E091A8,50,50", "white");
+   * ```
+   */
+  function setFilterColor(filterColor: string, backgroundColor: string): void;
+
+  /**
+   * 对图像执行 OCR 识别
+   * @param input 输入源（imageId、URL字符串、文件路径或"screen"，"screen"表示使用当前屏幕）
+   * @param type 识别类型 默认3: 检测 + 识别；0: 只检测；1: 方向分类+识别；2: 只识别；3: 检测+识别
+   * @param x 边界框左上角x坐标
+   * @param y 边界框左上角y坐标
+   * @param ex 边界框右下角x坐标
+   * @param ey 边界框右下角y坐标
+   * @returns OCR识别结果JSON字符串
+   * @example
+   * ```typescript
+   * // 识别屏幕
+   * const result1 = tomatoOcr.ocrImage("screen", 0, 0, 0, 0, 0);
+   * logi(`识别屏幕结果：${result1}`);
+   *
+   * // 识别文件
+   * const result2 = tomatoOcr.ocrImage("/path/to/image.png", 0);
+   * logi(`识别文件结果：${result2}`);
+   *
+   * // 识别指定屏幕区域
+   * const result3 = tomatoOcr.ocrImage("screen", 0);
+   * logi(`识别指定屏幕区域结果：${result3}`);
+   * ```
+   */
+  function ocrImage(
+    input: string,
+    type: number,
+    x?: number,
+    y?: number,
+    ex?: number,
+    ey?: number
+  ): string;
+
+  /**
+   * 查找点击点
+   * @param data 要找的文字
+   * @returns 找“要找的文字”的中心点 没有找到返回空字符串
+   * @example
+   * ```typescript
+   * const result = tomatoOcr.findTapPoint('{"text": "确定"}');
+   * const tapPoint = JSON.parse(result);
+   * logi(tapPoint);
+   * ```
+   */
+  function findTapPoint(data: string): string;
+
+  /**
+   * 查找多个点击点
+   * @param data 要找的文字
+   * @returns 找“要找的文字”的所有相匹配的中心点 没有找到返回空字符串
+   * @example
+   * ```typescript
+   * const result = tomatoOcr.findTapPoints('{"texts": ["确定", "取消"]}');
+   * const tapPoints = JSON.parse(result);
+   * logi(tapPoints);
+   * ```
+   */
+  function findTapPoints(data: string): string;
+}

package/types/tts.d.ts

@@ -1,91 +1,91 @@
-/**
- * TTS（文本转语音）模块 包含语音合成、播放控制等功能
- */
-declare namespace tts {
-  /**
-   * 语音信息接口
-   */
-  interface VoiceInfo {
-    /** 语音标识符 */
-    identifier: string;
-    /** 语音名称 */
-    name: string;
-    /** 语言代码 */
-    language: string;
-    /** 语音质量等级 */
-    quality: number;
-  }
-
-  /**
-   * 播放文本转语音（5参数版本）
-   * @param text 要转换的文本
-   * @param rate 语速，范围0.0-1.0，默认0.5
-   * @param pitch 音调，范围0.5-2.0，默认1.0
-   * @param volume 音量，范围0.0-1.0，默认1.0
-   * @param language 语言代码，默认"zh-CN"
-   * @returns 是否成功开始播放
-   * @example
-   * const success = tts.speak("你好世界", 0.5, 1.0, 1.0, "zh-CN");
-   */
-  function speak(
-    text: string,
-    rate?: number,
-    pitch?: number,
-    volume?: number,
-    language?: string
-  ): boolean;
-
-  /**
-   * 等待当前语音播放结束
-   * @example
-   * tts.waitEnd();
-   */
-  function waitEnd(): void;
-
-  /**
-   * 停止当前播放
-   * @example
-   * tts.stop();
-   */
-  function stop(): void;
-
-  /**
-   * 检查是否正在播放
-   * @returns 是否正在播放
-   * @example
-   * if (tts.isSpeaking()) {
-   *   logi("正在播放");
-   * }
-   */
-  function isSpeaking(): boolean;
-
-  /**
-   * 获取可用的语音列表
-   * @returns 语音信息数组
-   * @example
-   * const voices = tts.getAvailableVoices();
-   * voices.forEach(voice => {
-   *   logi(`语音: ${voice.name}, 语言: ${voice.language}, 标识符: ${voice.identifier}, 质量: ${voice.quality}`);
-   * });
-   */
-  function getAvailableVoices(): VoiceInfo[];
-
-  /**
-   * 设置语音
-   * @param voiceIdentifier 语音标识符
-   * @returns 是否设置成功
-   * @example
-   * const success = tts.setVoice("com.apple.ttsbundle.siri_Yu-shu_zh-CN_compact");
-   * if (success) {
-   *   logi("语音设置成功");
-   * }
-   */
-  function setVoice(voiceIdentifier: string): boolean;
-
-  /**
-   * 释放TTS资源（调用时，会停止当前播放并释放资源）
-   * @example
-   * tts.free();
-   */
-  function free(): void;
-}
+/**
+ * TTS（文本转语音）模块 包含语音合成、播放控制等功能
+ */
+declare namespace tts {
+  /**
+   * 语音信息接口
+   */
+  interface VoiceInfo {
+    /** 语音标识符 */
+    identifier: string;
+    /** 语音名称 */
+    name: string;
+    /** 语言代码 */
+    language: string;
+    /** 语音质量等级 */
+    quality: number;
+  }
+
+  /**
+   * 播放文本转语音（5参数版本）
+   * @param text 要转换的文本
+   * @param rate 语速，范围0.0-1.0，默认0.5
+   * @param pitch 音调，范围0.5-2.0，默认1.0
+   * @param volume 音量，范围0.0-1.0，默认1.0
+   * @param language 语言代码，默认"zh-CN"
+   * @returns 是否成功开始播放
+   * @example
+   * const success = tts.speak("你好世界", 0.5, 1.0, 1.0, "zh-CN");
+   */
+  function speak(
+    text: string,
+    rate?: number,
+    pitch?: number,
+    volume?: number,
+    language?: string
+  ): boolean;
+
+  /**
+   * 等待当前语音播放结束
+   * @example
+   * tts.waitEnd();
+   */
+  function waitEnd(): void;
+
+  /**
+   * 停止当前播放
+   * @example
+   * tts.stop();
+   */
+  function stop(): void;
+
+  /**
+   * 检查是否正在播放
+   * @returns 是否正在播放
+   * @example
+   * if (tts.isSpeaking()) {
+   *   logi("正在播放");
+   * }
+   */
+  function isSpeaking(): boolean;
+
+  /**
+   * 获取可用的语音列表
+   * @returns 语音信息数组
+   * @example
+   * const voices = tts.getAvailableVoices();
+   * voices.forEach(voice => {
+   *   logi(`语音: ${voice.name}, 语言: ${voice.language}, 标识符: ${voice.identifier}, 质量: ${voice.quality}`);
+   * });
+   */
+  function getAvailableVoices(): VoiceInfo[];
+
+  /**
+   * 设置语音
+   * @param voiceIdentifier 语音标识符
+   * @returns 是否设置成功
+   * @example
+   * const success = tts.setVoice("com.apple.ttsbundle.siri_Yu-shu_zh-CN_compact");
+   * if (success) {
+   *   logi("语音设置成功");
+   * }
+   */
+  function setVoice(voiceIdentifier: string): boolean;
+
+  /**
+   * 释放TTS资源（调用时，会停止当前播放并释放资源）
+   * @example
+   * tts.free();
+   */
+  function free(): void;
+}