@overwolf/ow-electron-packages-types 1.1.5 → 1.1.6-beta.1

package/package.json

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

package/types.d.ts

@@ -1,3 +1,4 @@
+import '@overwolf/ow-electron';
 import type {
   BrowserWindow,
   BrowserWindowConstructorOptions,
@@ -3070,6 +3071,18 @@ interface EncoderSettingsNVENC extends VideoEncoderSettingsBase {
    */
   rate_control?: kNVENCEncoderRateControl;
 
+  /**
+   * Constant Quantization Parameter (CQP) level.
+   *
+   * Sets a fixed quality level for the entire stream. Only applies when
+   * {@link rate_control} is `'CQP'`.
+   *
+   * Range: `1`–`51` (`1`–`63` for AV1).
+   *
+   * @default 20
+   */
+  cqp?: number;
+
   /**
    * Encoding quality preset.
    *
@@ -3253,11 +3266,21 @@ interface EncoderSettingsAMF extends VideoEncoderSettingsBase {
   ffmpeg_opts?: string;
 
   /**
-   * Constant Peak Quantizer (CPQ) value.
-   * Determines the quality level when using quantizer-based rate control modes.
+   * Constant Quantization Parameter (CQP) level.
+   *
+   * Determines the quality level for quantizer-based rate control. Only applies
+   * when {@link rate_control} is `'CQP'` or `'QVBR'`.
+   *
+   * Range: `0`–`51` (`0`–`63` for AV1).
    *
    * @default 20
    */
+  cqp?: number;
+
+  /**
+   * @deprecated Use {@link cqp} instead. Retained for backward compatibility;
+   * this value is ignored by the encoder.
+   */
   cpq?: number;
 
   /**
@@ -3363,6 +3386,30 @@ interface EncoderSettingsQuickSync extends VideoEncoderSettingsBase {
    */
   rate_control?: kQuickSyncEncoderRateControl;
 
+  /**
+   * Constant Quantization Parameter (CQP) level.
+   *
+   * Sets a fixed quantizer for the entire stream. Only applies when
+   * {@link rate_control} is `'CQP'`.
+   *
+   * Range: `1`–`51` (`1`–`63` for AV1).
+   *
+   * @default 23
+   */
+  cqp?: number;
+
+  /**
+   * Intelligent Constant Quality (ICQ) level.
+   *
+   * Lower values yield higher quality. Only applies when
+   * {@link rate_control} is `'ICQ'`.
+   *
+   * Range: `1`–`51`.
+   *
+   * @default 23
+   */
+  icq_quality?: number;
+
   /**
    * Target usage or encoding preset that balances performance and quality.
    *
@@ -3454,6 +3501,18 @@ interface EncoderSettingsX264 extends VideoEncoderSettingsBase {
    */
   rate_control?: kX264EncoderRateControl;
 
+  /**
+   * Constant Rate Factor (CRF) quality level.
+   *
+   * Lower values yield higher quality and larger files. Only applies when
+   * {@link rate_control} is `'CRF'` or `'VBR'`.
+   *
+   * Range: `0`–`51`.
+   *
+   * @default 23
+   */
+  crf?: number;
+
   /**
    * Specifies the encoding speed/quality trade-off preset.
    * A slower preset provides better compression (quality per bitrate).
@@ -3756,6 +3815,29 @@ interface EncoderInformation {
   audio: AudioEncoderInfo[];
 }
 
+/**
+ * Crash dump detail level for the OBS host process.
+ * - `mini`: small dump (thread stacks + module list); the default.
+ * - `full`: complete-memory dump; large — opt-in for debugging only.
+ */
+type CrashDumpType = 'mini' | 'full';
+
+/**
+ * Crash dump configuration for the OBS host process.
+ */
+interface CrashDumpOptions {
+  /**
+   * Dump detail level; defaults to `mini`. See {@link CrashDumpType}.
+   */
+  type?: CrashDumpType;
+
+  /**
+   * Max crash dumps to retain in `ow-obs/crashdumps`; the oldest are deleted
+   * beyond this count. Positive integer, defaults to `3`.
+   */
+  maxFiles?: number;
+}
+
 /**
  * Configuration options for launching or customizing the recording application behavior.
  *
@@ -3767,6 +3849,7 @@ interface EncoderInformation {
  * const options: RecordingAppOptions = {
  *   showDebugWindow: true,
  *   enableDebugLogs: true,
+ *   maxLogFiles: 20,
  * };
  * ```
  */
@@ -3782,6 +3865,22 @@ interface RecordingAppOptions {
    * Can be used to troubleshoot issues during recording.
    */
   enableDebugLogs?: boolean;
+
+  /**
+   * Maximum number of OBS log files to retain under the recorder's
+   * `ow-obs/logs` folder. Once the number of logs exceeds this value, the
+   * oldest logs are gradually pruned.
+   * Must be a positive integer. Defaults to `10`.
+   */
+  maxLogFiles?: number;
+
+  /**
+   * Tune OBS-host crash dumps. Mini-dump capture is always on; these options
+   * only change the detail level and retention count.
+   *
+   * @see {@link CrashDumpOptions}
+   */
+  crashDumps?: CrashDumpOptions;
 }
 
 
@@ -4984,6 +5083,33 @@ interface OverlayWindowOptions
    */
   disableHardwareAcceleration?: boolean;
 
+  /**
+   * ⚠️ BETA — this option is experimental and its behavior may change in
+   * a future release.
+   *
+   * `true`—renders this overlay window through a GPU shared texture
+   * instead of copying pixels through shared memory on every paint. The overlay
+   * forwards the GPU texture handle directly to the injected game process, which
+   * composites it without any CPU-side pixel copy, significantly lowering
+   * per-frame CPU overhead.
+   *
+   * Requires hardware acceleration to be enabled and the current game to report
+   * shared-texture support (see {@link GameWindowInfo.isSharedTextureSupported}).
+   * The flag is silently ignored when either condition is not met, falling back
+   * to the shared-memory (CPU copy) path.
+   *
+   * The rendering path follows the active game: when the overlay moves to a
+   * different game, a shared-texture window automatically falls back to the
+   * shared-memory (CPU copy) path on a game that does not support shared
+   * texture, and restores the shared-texture path on a game that does — so the
+   * window stays visible on every game.
+   *
+   * @default false
+   *
+   * @since 2.0.2
+   */
+  useSharedTexture?: boolean;
+
   /**
    * Enables Chromium process isolation (sandboxing).
    * Used to enforce stricter security policies or prevent resource sharing between renderer processes.
@@ -5332,11 +5458,17 @@ interface GameWindowInfo {
 
   /**
    * Indicates if fullscreen rendering is disabled.
-   * 
+   *
    * Relevant only for OOPO games.
    * @since 1.9.0
    */
   readonly isOOPOFullscreenRenderingDisabled?: boolean;
+
+  /**
+   * Indicates if the game supports shared-texture (GPU) overlay rendering.
+   * @since 2.0.0
+   */
+  readonly isSharedTextureSupported?: boolean;
 }
 
 /**