@overwolf/ow-electron-packages-types 1.1.14-beta.1 → 1.1.14-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@overwolf/ow-electron-packages-types",
-    "version": "1.1.14-beta.1",
+    "version": "1.1.14-beta.2",
     "description": "Type definition file for autocompletion and documentation purposes for ow-electron packages",
     "license": "MIT",
     "types": "types.d.ts",

package/types.d.ts

@@ -4565,16 +4565,17 @@ interface ReplayOptions extends RecordingBaseOptions {
   rootFolder: string;
 
   /**
-   * How long (ms) to wait for OBS to acknowledge a stop before force-killing
-   * the process. Defaults to `30000` ms.
+   * How long (ms) a replays stop may take before it is forced. A forced stop
+   * ends on the next frame and drops whatever the encoder had not caught up
+   * on yet. If it still has not stopped 30 s later, OBS is restarted and
+   * every running output is reported stopped with `ProcessTerminated`.
+   * Defaults to `60000` ms.
    */
   stopReplaysKillTimeoutMs?: number;
 
   /**
-   * Output frame-skip rate (0–1) at which OBS is considered critically
-   * overloaded during an active recording. If this threshold is reached when
-   * the stop-replays timeout fires, OBS is force-killed even while a recording
-   * is active. Defaults to `0.5`.
+   * @deprecated No effect. Stops are now forced and, if needed, OBS restarted
+   * on a fixed schedule; see `stopReplaysKillTimeoutMs`.
    */
   criticalEncodeSkipRate?: number;
 }
@@ -4682,6 +4683,10 @@ interface CaptureReplayOptions {
   /**
    * The video length, in milliseconds, to include prior to the time this method is called.
    * This allows capturing moments that happened just before the replay trigger.
+   *
+   * A clip must start on a keyframe, so it starts on the last keyframe before
+   * that point and can be up to one keyframe interval longer than asked. Set
+   * `keyint_sec` (e.g. `1`) in the video encoder settings for tighter clips.
    */
   pastDuration: number;
 
@@ -4942,6 +4947,45 @@ interface RecorderStats {
   outputTotalFrames: number;
 }
 
+/**
+ * What a 'performance-warning' measured. Both show as a choppy or frozen
+ * video, but different settings fix them.
+ * - `encoding-lag`: the encoder could not keep up, so frames were skipped and
+ *   the previous one repeated. The video also falls behind real time, so clips
+ *   and recordings can hold older footage than requested. Use a faster encoder
+ *   preset, a lower resolution or frame rate, or another encoder. Bitrate has
+ *   little effect.
+ * - `rendering-lag`: the recorder could not compose frames in time, usually
+ *   because the game takes the whole GPU. Lower the frame rate (most effective)
+ *   or the resolution; an encoder change does not help.
+ */
+type PerformanceWarningType = 'encoding-lag' | 'rendering-lag';
+
+/**
+ * Reported with the 'performance-warning' event.
+ *
+ * Measured since the recording or replays started, after a warm-up of 1000
+ * rendered frames, and over at least 1000 more.
+ */
+interface PerformanceWarningArgs {
+  type: PerformanceWarningType;
+
+  /**
+   * Percentage of frames skipped, 0 to 100.
+   */
+  percentage: number;
+
+  /**
+   * Number of frames skipped.
+   */
+  skippedFrames: number;
+
+  /**
+   * Number of frames measured.
+   */
+  totalFrames: number;
+}
+
 /**
  * Recording error information including a specific error code and description.
  * Useful for detailed debugging and error handling during recording operations.
@@ -5235,6 +5279,18 @@ interface IOverwolfRecordingApi {
    *
    */
   on(eventName: 'stats', listener: (args: RecorderStats) => void): this;
+
+  /**
+   * @event Fired on every 5% rise of skipped frames while recording or replays
+   * run (5%, 10%, ...).
+   *
+   * The recorder only reports; lowering the capture settings is the caller's
+   * decision. See {@link PerformanceWarningType} for what helps.
+   */
+  on(
+    eventName: 'performance-warning',
+    listener: (args: PerformanceWarningArgs) => void,
+  ): this;
 }