@overwolf/ow-electron-packages-types 0.1.0-beta.9 → 0.2.0-beta.0

package/docs/recorder/types.md

@@ -122,12 +122,10 @@ Once the settings are ready to be applied, use the `build()` method to create th
 
 
 ### kSupportedEncodersTypes
+  jim_* are deprecated since obs 0.31.0. instead we use obs_nvenc_* encoders
   ```
   ffmpeg_svt_av1
   ffmpeg_aom_av1
-  jim_nvenc
-  jim_hevc_nvenc
-  jim_av1_nvenc
   obs_x264
   h264_texture_amf
   h265_texture_amf
@@ -135,6 +133,9 @@ Once the settings are ready to be applied, use the `build()` method to create th
   obs_qsv11_v2
   obs_qsv11_hevc
   obs_qsv11_av1
+  obs_nvenc_h264_tex
+  obs_nvenc_hevc_tex
+  obs_nvenc_av1_tex
   ```
 
 ### AdapterInfo

package/package.json

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

package/types.d.ts

@@ -4,6 +4,8 @@ BrowserWindow,
 BrowserWindowConstructorOptions,
 Size,
 WebContents,
+Display,
+Rectangle
 } from 'electron';
 
 import { EventEmitter } from 'events';
@@ -112,9 +114,23 @@ type ZOrderType = "default" | "topMost" | "bottomMost";
 
 /** Overlay ow-electron options */
 interface OverlayOptions {
+  /**
+   * Controls how input events are handled by the overlay window
+   * @default 'noPassThrough'
+   */
   passthrough?: PassthroughType;
 
+  /**
+   * Controls the Z-order (stacking order) of the overlay window relative to other window
+   * @default 'default'
+   */
   zOrder?: ZOrderType;
+
+  /**
+   * If true, the overlay will not intercept keyboard input.
+   * @default false
+   */
+  ignoreKeyboardInput?: boolean;
 }
 
 interface OverlayWindowOptions
@@ -168,10 +184,27 @@ interface InjectionError {
 }
 
 interface GameWindowInfo {
-  size: Size;
-  nativeHandle: number;
-  focused: boolean;
-  graphics: 'd3d9' | 'd3d12' | 'd3d11' | string | undefined;
+  /** The dimensions of the game window. */
+  readonly size: Size;
+
+  /** The native window handle (HWND) of the game window. */
+  readonly nativeHandle: number;
+
+  /** Indicates whether the game window is currently focused. */
+  readonly focused: boolean;
+
+  /** The graphics API used by the game (e.g., Direct3D 9, 11, 12, Vulkan). */
+  readonly graphics: 'd3d9' | 'd3d12' | 'd3d11' | 'vulkan' | string | undefined;
+
+  /** Display information for the screen on which the game window resides.
+   *  Available since version 1.5.11.
+   */
+  readonly screen?: Display;
+
+  /** The bounding rectangle of the game window in screen coordinates.
+   * Available since version 1.5.11.
+   */
+  readonly bounds?: Rectangle;
 }
 
 interface GameInputInterception {
@@ -407,18 +440,19 @@ type Rect = { top: number; left: number; width: number; height: number };
 type AudioDeviceType = 'input' | 'output';
 
 type kSupportedEncodersTypes =
+// jim_* are deprecated since obs 0.31.0. instead we use obs_nvenc_* encoders
   | 'ffmpeg_svt_av1'
   | 'ffmpeg_aom_av1'
-  | 'jim_nvenc'
-  | 'jim_hevc_nvenc'
-  | 'jim_av1_nvenc'
   | 'obs_x264'
   | 'h264_texture_amf'
   | 'h265_texture_amf'
   | 'av1_texture_amf'
   | 'obs_qsv11_v2'
   | 'obs_qsv11_hevc'
-  | 'obs_qsv11_av1';
+  | 'obs_qsv11_av1'
+  | 'obs_nvenc_h264_tex'
+  | 'obs_nvenc_hevc_tex'
+  | 'obs_nvenc_av1_tex';
 
 type kKnownAudioEncodersTypes =
   | 'ffmpeg_aac'
@@ -540,7 +574,8 @@ type kFileFormat =
   | 'mkv'
   | 'mov'
   | 'mpegts'
-  | 'hls';
+  | 'hls'
+  | 'hybrid_mp4';
 
 type kVideoColorFormat =
   | 'NV12'
@@ -1564,6 +1599,16 @@ interface IOverwolfRecordingApi {
    */
   isActive(): Promise<boolean>;
 
+  /**
+   * Is recording active
+   */
+  isRecordingActive(): Promise<boolean>;
+
+  /**
+   * Is replay  active
+   */
+  isReplayActive(): Promise<boolean>;
+
   /**
    * Query System information.
    *