ms-types 0.9.2 → 0.9.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ms-types",
-  "version": "0.9.2",
+  "version": "0.9.4",
   "type": "module",
   "license": "MIT",
   "publishConfig": {

package/types/paddleocr.d.ts

@@ -36,7 +36,7 @@ declare namespace paddleOcr {
    * 初始化PP-OCRv5模型
    * @param maxSideLen 最大边长，默认640，可不传
    * @param useGpu 是否使用GPU，默认false，可不传
-   * @returns 初始化是否成功
+   * @returns 初始化成功或模型已加载返回true
    * @example
    * const loaded = paddleOcr.loadV5(640, true)
    * if (loaded) {

package/types/pip.d.ts

@@ -16,8 +16,45 @@ declare namespace pip {
    */
   function switchToKeepAliveMode(): boolean;
   /**
-   * 切换到关闭模式
+   * 切换到自定义模式[首次显示悬浮窗时 App 必须在前台]
    * @returns true代表已提交切换请求
    */
-  function switchToOffMode(): boolean;
+  function switchToCustomMode(): boolean;
+  /**
+   * 关闭悬浮窗
+   * @returns true代表已提交关闭请求
+   */
+  function closeWindow(): boolean;
+  /**
+   * 设置日志模式或自定义模式的悬浮窗内容尺寸
+   * 日志模式和自定义模式会分别持久化尺寸；悬浮窗关闭或保活模式返回 false
+   * @param width 目标内容宽度
+   * @param height 目标内容高度
+   * @returns true代表尺寸已提交，false代表当前模式不允许设置或宽高无效
+   */
+  function setContentSize(width: number, height: number): boolean;
+  /**
+   * 设置自定义模式显示的纯文本
+   * @param text 要显示的文本，支持换行
+   * @returns true代表文本已提交
+   */
+  function setCustomText(text: string): boolean;
+  /**
+   * 设置自定义模式显示文本的文字颜色
+   * @param color 文字颜色，支持 RRGGBB、RRGGBBAA，可带 # 前缀；末尾 AA 为透明度
+   * @returns true代表文字颜色已提交
+   */
+  function setCustomTextColor(color: string): boolean;
+  /**
+   * 设置自定义模式显示文本的文字大小
+   * @param fontSize 文字字号，必须是有效数字
+   * @returns true代表文字大小已提交，false代表字号无效
+   */
+  function setCustomTextSize(fontSize: number): boolean;
+  /**
+   * 设置自定义模式显示区域的背景色
+   * @param color 背景颜色，支持 RRGGBB、RRGGBBAA，可带 # 前缀；末尾 AA 为透明度
+   * @returns true代表背景色已提交
+   */
+  function setCustomBackgroundColor(color: string): boolean;
 }

package/types/yolo.d.ts

@@ -51,17 +51,17 @@ declare namespace yolo {
    * 加载YOLO模型
    * @param paramPath ncnn模型的param文件的绝对路径
    * @param binPath ncnn模型的bin文件绝对路径
-   * @param nc 模型的标签数量,可在标签集data.yaml中看到
+   * @param nc 模型的标签数量；传 0 或省略时根据模型输出自动推断，显式传入但不匹配时检测返回空数组
    * @param version 模型版本，默认11, 支持 8 11 26
    * @param useGpu 是否使用 GPU 加载
    * @returns 加载成功返回模型ID字符串，失败返回null
    * @example
-   * const modelId = yolo.load("yolov8n.param", "yolov8n.bin", 80)
+   * const modelId = yolo.load("yolov8n.param", "yolov8n.bin", 0)
    */
   function load(
     paramPath: string,
     binPath: string,
-    nc: number,
+    nc?: number,
     version?: number,
     useGpu?: boolean,
   ): string | null;
@@ -69,16 +69,16 @@ declare namespace yolo {
    * 加载YOLOv11模型 （兼容 yolov8 模型）
    * @param paramPath ncnn模型的param文件的绝对路径
    * @param binPath ncnn模型的bin文件绝对路径
-   * @param nc 模型的标签数量,可在标签集data.yaml中看到
+   * @param nc 模型的标签数量；传 0 或省略时根据模型输出自动推断，显式传入但不匹配时检测返回空数组
    * @param useGpu 是否使用 GPU 加载
    * @returns 加载成功返回模型ID字符串，失败返回null
    * @example
-   * const modelId = yolo.loadV11("yolov11n.param", "yolov11n.bin", 80)
+   * const modelId = yolo.loadV11("yolov11n.param", "yolov11n.bin", 0)
    */
   function loadV11(
     paramPath: string,
     binPath: string,
-    nc: number,
+    nc?: number,
     useGpu?: boolean,
   ): string | null;
 

package/types/yoloCls.d.ts

@@ -32,7 +32,7 @@ declare namespace yoloCls {
    * 加载 YOLO 分类模型
    * @param paramPath ncnn 模型 param 文件路径
    * @param binPath ncnn 模型 bin 文件路径
-   * @param nc 模型类别数量，传 0 时按模型输出自动推断
+   * @param nc 模型类别数量，传 0 或省略时按模型输出自动推断，显式传入但不匹配时分类返回空结果
    * @param useGpu 是否使用 GPU 加载
    * @returns 加载成功返回模型 ID 字符串，失败返回 null
    * @example

package/types/zh/PaddleOCR/346/250/241/345/235/227.d.ts

@@ -35,9 +35,9 @@ declare namespace $PaddleOCR {
 
   /**
    * 初始化PP-OCRv5模型
-   * @param maxSideLen 最大边长，默认640，可不传
+   * @param 最大边长 最大边长，默认640，可不传
    * @param useGpu 是否使用GPU，默认false，可不传
-   * @returns 初始化是否成功
+   * @returns 初始化成功或模型已加载返回true
    * @example
    * const 是否加载成功 = $PaddleOCR.加载V5模型(640, true)
    * if (是否加载成功) {

package/types/zh/YOLO/345/210/206/347/261/273/346/250/241/345/235/227.d.ts

@@ -34,7 +34,7 @@ declare namespace $YOLO分类 {
    * 加载 YOLO 分类模型
    * @param ncnn模型的param文件路径 ncnn 模型 param 文件路径
    * @param ncnn模型的bin文件路径 ncnn 模型 bin 文件路径
-   * @param 类别数量 模型类别数量，传 0 时按模型输出自动推断
+   * @param 类别数量 模型类别数量，传 0 或省略时按模型输出自动推断，显式传入但不匹配时分类返回空结果
    * @param useGpu 是否使用 GPU 加载
    * @returns 加载成功返回模型 ID 字符串，失败返回 null
    * @example

package/types/zh/YOLO/346/250/241/345/235/227.d.ts

@@ -54,17 +54,17 @@ declare namespace $YOLO {
    * 加载YOLO模型
    * @param ncnn模型的param文件路径 ncnn模型的param文件的绝对路径
    * @param ncnn模型的bin文件路径 ncnn模型的bin文件绝对路径
-   * @param 标签数量 模型的标签数量,可在标签集data.yaml中看到
+   * @param 标签数量 模型的标签数量；传 0 或省略时根据模型输出自动推断，显式传入但不匹配时检测返回空数组
    * @param 模型版本 模型版本，默认11, 支持 8 11 26
    * @param useGpu 是否使用 GPU 加载
    * @returns 加载成功返回模型ID字符串，失败返回null
    * @example
-   * const 模型ID = $YOLO.加载模型("yolov8n.param", "yolov8n.bin", 80)
+   * const 模型ID = $YOLO.加载模型("yolov8n.param", "yolov8n.bin", 0)
    */
   function 加载模型(
     ncnn模型的param文件路径: 字符串,
     ncnn模型的bin文件路径: 字符串,
-    标签数量: 数字,
+    标签数量?: 数字,
     模型版本?: 数字,
     useGpu?: 布尔值,
   ): 字符串 | null;
@@ -73,16 +73,16 @@ declare namespace $YOLO {
    * 加载YOLOv11模型 （兼容 yolov8 模型）
    * @param ncnn模型的param文件路径
    * @param ncnn模型的bin文件路径
-   * @param 标签数量 模型的标签数量,可在标签集data.yaml中看到
+   * @param 标签数量 模型的标签数量；传 0 或省略时根据模型输出自动推断，显式传入但不匹配时检测返回空数组
    * @param useGpu 是否使用 GPU 加载
    * @returns 加载成功返回模型ID字符串，失败返回null
    * @example
-   * const 模型ID = $YOLO.加载YOLOv11模型("yolov11n.param", "yolov11n.bin", 80)
+   * const 模型ID = $YOLO.加载YOLOv11模型("yolov11n.param", "yolov11n.bin", 0)
    */
   function 加载YOLOv11模型(
     ncnn模型的param文件路径: 字符串,
     ncnn模型的bin文件路径: 字符串,
-    标签数量: 数字,
+    标签数量?: 数字,
     useGpu?: 布尔值,
   ): 字符串 | null;
 

package/types/zh//346/202/254/346/265/256/347/252/227/346/250/241/345/235/227.d.ts

@@ -20,8 +20,45 @@ declare namespace $悬浮窗 {
    */
   function 切换到保活模式(): 布尔值;
   /**
-   * 切换到关闭模式
+   * 切换到自定义模式[首次显示悬浮窗时 App 必须在前台]
    * @returns true代表已提交切换请求
    */
-  function 切换到关闭模式(): 布尔值;
+  function 切换到自定义模式(): 布尔值;
+  /**
+   * 关闭悬浮窗
+   * @returns true代表已提交关闭请求
+   */
+  function 关闭悬浮窗(): 布尔值;
+  /**
+   * 设置日志模式或自定义模式的悬浮窗内容尺寸
+   * 日志模式和自定义模式会分别持久化尺寸；悬浮窗关闭或保活模式返回 false
+   * @param 宽度 目标内容宽度
+   * @param 高度 目标内容高度
+   * @returns true代表尺寸已提交，false代表当前模式不允许设置或宽高无效
+   */
+  function 设置内容尺寸(宽度: 数字, 高度: 数字): 布尔值;
+  /**
+   * 设置自定义模式显示的纯文本
+   * @param 文本 要显示的文本，支持换行
+   * @returns true代表文本已提交
+   */
+  function 设置自定义文本(文本: 字符串): 布尔值;
+  /**
+   * 设置自定义模式显示文本的文字颜色
+   * @param 颜色 文字颜色，支持 RRGGBB、RRGGBBAA，可带 # 前缀；末尾 AA 为透明度
+   * @returns true代表文字颜色已提交
+   */
+  function 设置自定义文字颜色(颜色: 字符串): 布尔值;
+  /**
+   * 设置自定义模式显示文本的文字大小
+   * @param 字号 文字字号，必须是有效数字
+   * @returns true代表文字大小已提交，false代表字号无效
+   */
+  function 设置自定义文字大小(字号: 数字): 布尔值;
+  /**
+   * 设置自定义模式显示区域的背景色
+   * @param 颜色 背景颜色，支持 RRGGBB、RRGGBBAA，可带 # 前缀；末尾 AA 为透明度
+   * @returns true代表背景色已提交
+   */
+  function 设置自定义背景色(颜色: 字符串): 布尔值;
 }