@solazah/solazah-runtime 0.1.126 → 0.1.134

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solazah/solazah-runtime",
-  "version": "0.1.126",
+  "version": "0.1.134",
   "main": "index.cjs",
   "module": "index.js",
   "types": "types/index.d.ts",

package/types/SystemRecorder.d.ts

@@ -0,0 +1,60 @@
+import { default as IpcRenderer } from './IpcRenderer';
+export interface RecorderStartOptions {
+    /** 帧率,缺省 4 */
+    fps?: number;
+    /** 结束录制的键(虚拟键码),缺省 F12;这一下本身不进轨迹 */
+    stopKey?: number;
+    /** 时长上限,缺省 10 分钟 */
+    maxMs?: number;
+}
+export interface RecorderStatus {
+    supported: boolean;
+    active: boolean;
+    id: string | null;
+    elapsedMs: number;
+    events: number;
+    frames: number;
+    /** 运行中的反作弊进程名;有它在时低层钩子整体收不到输入 */
+    antiCheat: string[];
+}
+export interface RecorderResult {
+    id: string;
+    /** 轨迹目录绝对路径 */
+    dir: string;
+    /** 轨迹目录在工作空间「图片」目录下的相对路径:scripts/_recordings/<id> */
+    relPath: string;
+    events: number;
+    frames: number;
+    durationMs: number;
+    stoppedBy: "hotkey" | "api" | "timeout";
+}
+export default class SystemRecorder {
+    private transport;
+    constructor(transport?: IpcRenderer);
+    /**
+     * 开始录制用户操作:低层钩子收鼠标键盘、定时截主屏,每个按下/抬起/按键带上前后帧与那一刻的前台窗口。
+     * 只记事实,不做任何手势归并;录制期间每一拍向发起方视图推 `recorder.progress`(RecorderStatus)。
+     * 产物落在工作空间「图片」目录 scripts/_recordings/<id>/:trajectory.json + frames/*.png。
+     *
+     * @param options `{fps?, stopKey?, maxMs?}`,缺省 4 帧/秒、F12 结束、10 分钟上限。
+     * @returns `{id, dir, relPath, antiCheat}`;antiCheat 非空表示有反作弊进程在跑,钩子会整体收不到输入。
+     * @throws 平台不支持(目前仅 Windows)、已有录制在进行、钩子安装失败时抛错。
+     */
+    start: (options?: RecorderStartOptions) => Promise<{
+        id: string;
+        dir: string;
+        relPath: string;
+        antiCheat: string[];
+    }>;
+    /**
+     * 结束录制并写出轨迹。按 stopKey 结束的录制不必再调。
+     *
+     * @returns `{id, dir, relPath, events, frames, durationMs, stoppedBy}`。
+     * @throws 没有进行中的录制时抛错。
+     */
+    stop: () => Promise<RecorderResult>;
+    /**
+     * 录制状态:是否支持、是否进行中、已录事件数与帧数、运行中的反作弊进程。
+     */
+    status: () => Promise<RecorderStatus>;
+}