@overwolf/ow-electron-packages-types 1.1.6 → 1.1.8

package/package.json

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

package/types.d.ts

@@ -70,9 +70,9 @@ interface IOverwolfUtilityApi {
    * Allows injection into high elevation games.
    * No-ops if files are already present.
    *
-   * @throws \{HelperInstallError\} `exitCode 1223` — user cancelled the UAC prompt (ERROR_CANCELLED)
-   * @throws - {HelperInstallError} `err.exitCode !== 1223` — the installer process failed. Log `err.exitCode` and investigate.
-   * @throws \{HelperInstallError\} any other non-zero exitCode — installation failed.
+   * @throws `HelperInstallError` `exitCode 1223` — user cancelled the UAC prompt (ERROR_CANCELLED)
+   * @throws `HelperInstallError` `err.exitCode !== 1223` — the installer process failed. Log `err.exitCode` and investigate.
+   * @throws `HelperInstallError` any other non-zero exitCode — installation failed.
    *
    * @remarks
    * The helper binaries are installed to:
@@ -1782,7 +1782,8 @@ type VideoRecordingSplitType =
  * 
  * This interface serves as a blueprint for all audio filters within the system,
  * ensuring they have a unique identifier and a flexible container for settings.
- * * @example
+ *
+ * @example
  * ```typescript
  * const lowPass: AudioFilterBase = {
  * id: 'low-pass-001',
@@ -1808,7 +1809,8 @@ export interface AudioFilterBase {
 
 /**
  * A specialized filter for dynamic range compression.
- * * @example
+ *
+ * @example
  * ```typescript
  * const vocalComp: AudioCompressorFilter = {
  * id: 'compressor_filter',
@@ -1863,7 +1865,8 @@ export interface AudioCompressorFilter extends AudioFilterBase {
 
 /**
  * A specialized filter for dynamic range expansion or noise gating.
- * * @example
+ *
+ * @example
  * ```typescript
  * const noiseGate: AudioExpanderFilter = {
  * id: 'expander_filter',
@@ -1932,7 +1935,8 @@ export interface AudioExpanderFilter extends AudioFilterBase {
 
 /**
  * A simple filter used to adjust the volume or amplitude of an audio signal.
- * * @example
+ *
+ * @example
  * ```typescript
  * const boost: AudioGainFilter = {
  * id: 'gain_filter',
@@ -1963,7 +1967,8 @@ export interface AudioGainFilter extends AudioFilterBase {
 
 /**
  * A utility filter that flips the phase of the audio signal by 180 degrees.
- * * @example
+ *
+ * @example
  * ```typescript
  * const phaseFlip: AudioInvertPolarityFilter = {
  * id: 'invert_polarity_filter',
@@ -1985,7 +1990,8 @@ export interface AudioInvertPolarityFilter extends AudioFilterBase {
 
 /**
  * A specialized dynamics processor used to prevent an audio signal from exceeding a specific decibel level.
- * * @example
+ *
+ * @example
  * ```typescript
  * const masterLimiter: AudioLimiterFilter = {
  * id: 'limiter_filter',
@@ -2025,7 +2031,8 @@ export interface AudioLimiterFilter extends AudioFilterBase {
 /**
  * A noise gate filter used to attenuate signals that fall below a certain threshold.
  * It is primarily used to remove background noise during silent passages.
- * * @example
+ *
+ * @example
  * ```typescript
  * const gate: AudioNoiseGateFilter = {
  * id: 'noise_gate_filter',
@@ -2083,7 +2090,8 @@ export interface AudioNoiseGateFilter extends AudioFilterBase {
 
 /**
  * An advanced noise suppression filter utilizing machine learning or digital signal processing algorithms.
- * * @example
+ *
+ * @example
  * ```typescript
  * const aiDenoise: AudioNoiseSuppressFilterV2 = {
  * id: 'noise_suppress_filter_v2',
@@ -3910,6 +3918,7 @@ type ErrorCode =
   | -999  // Missing binaries required for recording. 'MissingBinaries'
   | -998  // Failed to connect to the OBS process. 'ConnectionOBSError'
   | -997  // Operation attempted while recording is already running. 'AlreadyRunning'
+  | -996  // Elevated game capture requested while the High Elevation Helper isn't installed. 'ElevationHelperMissing'
   | -12   // Attempted to split recording when split recording is disabled. 'SplitRecordingDisabled'
   | -11   // One or more required parameters are missing or invalid. 'MissingOrInvalidParameters'
   | -10   // No active recording session found. 'NoActiveRecording'
@@ -4034,6 +4043,10 @@ interface ReplayOptions extends RecordingBaseOptions {
    * This determines how much time will be retained in memory
    * before being written to disk on replay save.
    *
+   * Must be at least `1`. A shorter buffer can not hold a playable segment,
+   * and is rejected with a {@link RecorderError} carrying the
+   * `MissingOrInvalidParameters` (-11) code.
+   *
    * Example: `30` will capture the last 30 seconds before the save.
    */
   bufferSecond: number;
@@ -5006,7 +5019,7 @@ type ZOrderType = "default" | "topMost" | "bottomMost";
  *
  * @see {@link IOverwolfOverlayApi.setGpuPreference}.
  *
- * @since 2.1.0
+ * @since 2.0.5
  */
 type GpuPreference = "default" | "highPerformance";
 
@@ -5023,15 +5036,18 @@ type GpuPreference = "default" | "highPerformance";
  *   received in-game. The overlay retried, then fell back to the CPU copy path.
  *   {@link IOverwolfOverlayApi.setGpuPreference} may help when the root cause is
  *   adapter-related.
+ * - `handleTransportBlocked`—The GPU textures could not be shared with the game
+ *   process.
  *
  * @see {@link IOverwolfOverlayApi.on} `shared-texture-unavailable`.
  *
- * @since 2.1.0
+ * @since 2.0.5
  */
 type SharedTextureUnavailableReason =
   | "unsupportedGraphicsApi"
   | "gpuAdapterMismatch"
-  | "copyFailure";
+  | "copyFailure"
+  | "handleTransportBlocked";
 
 
 
@@ -5120,6 +5136,8 @@ interface OverlayWindowOptions
    *
    * @default false
    *
+   * @see {@link https://www.electronjs.org/docs/latest/tutorial/offscreen-rendering#software-output-device | Software output device}
+   *
    * @since 1.13.20
    */
   disableHardwareAcceleration?: boolean;
@@ -5148,6 +5166,8 @@ interface OverlayWindowOptions
    *
    * @default false
    *
+   * @see {@link https://dev.overwolf.com/ow-electron/reference/examples/overlay | Overlay examples}
+   *
    * @since 2.0.2
    */
   useSharedTexture?: boolean;
@@ -5532,7 +5552,9 @@ interface GameWindowInfo {
    *
    * `undefined` until the game is injected and its graphics API is detected.
    *
-   * @since 2.1.0
+   * @see {@link https://dev.overwolf.com/ow-electron/reference/examples/overlay | Overlay examples}
+   *
+   * @since 2.0.5
    */
   readonly isSharedTextureAvailable?: boolean;
 }
@@ -5875,7 +5897,7 @@ interface IOverwolfOverlayApi extends EventEmitter {
    * Allows injection into high elevation games.
    * No-ops if files are already present.
    *
-   * @throws \{HelperInstallError\}
+   * @throws `HelperInstallError`
    *  - `exitCode 1223` — user cancelled the UAC prompt (ERROR_CANCELLED)
    *  - `err.exitCode !== 1223` — the installer process failed. Log `err.exitCode` and investigate.
    *  - any other non-zero exitCode — installation failed.
@@ -6023,6 +6045,7 @@ interface IOverwolfOverlayApi extends EventEmitter {
    * @returns A promise that resolves once the preference has been recorded.
    * @throws If the registry cannot be written, or on a non-Windows platform.
    * @see {@link GpuPreference}.
+   * @see {@link https://dev.overwolf.com/ow-electron/reference/examples/overlay | Overlay examples}
    *
    * @example
    * ```ts
@@ -6034,7 +6057,7 @@ interface IOverwolfOverlayApi extends EventEmitter {
    * });
    * ```
    *
-   * @since 2.1.0
+   * @since 2.0.5
    */
   setGpuPreference(preference: GpuPreference): Promise<void>;
 
@@ -6049,7 +6072,7 @@ interface IOverwolfOverlayApi extends EventEmitter {
    * @see {@link IOverwolfOverlayApi.setGpuPreference}.
    * @see {@link GpuPreference}.
    *
-   * @since 2.1.0
+   * @since 2.0.5
    */
   getGpuPreference(): Promise<GpuPreference>;
 
@@ -6189,17 +6212,21 @@ interface IOverwolfOverlayApi extends EventEmitter {
    *   received in-game**. The overlay retried, then abandoned the path for this game.
    *   {@link IOverwolfOverlayApi.setGpuPreference} may help when the root cause is
    *   adapter-related; details are in the overlay log.
+   * - `handleTransportBlocked`&mdash;the GPU textures **could not be shared with the game
+   *   process**.
    *
    * Fires at most **once per injected game**. The first two reasons are detected when the
-   * game's graphics are detected, before any frame is sent; `copyFailure` is reached only
-   * after frames were sent and repeatedly failed to draw. Either way, the affected overlay
-   * windows have already been switched to the CPU copy path by the time the event fires, so
-   * they stay visible and interactive, and
+   * game's graphics are detected, before any frame is sent; `copyFailure` and
+   * `handleTransportBlocked` are reached only after frames were sent and repeatedly failed to
+   * arrive or draw. Either way, the affected overlay windows have already been switched to the
+   * CPU copy path by the time the event fires, so they stay visible and interactive, and
    * {@link GameWindowInfo.isSharedTextureAvailable} reports `false` for the game.
    *
    * @param eventName - `shared-texture-unavailable`
    * @param listener - Callback invoked once for the current game with the reason.
    *
+   * @see {@link https://dev.overwolf.com/ow-electron/reference/examples/overlay | Overlay examples}
+   *
    * @example
    * ```ts
    * overlay.on('shared-texture-unavailable', async (reason) => {
@@ -6210,7 +6237,7 @@ interface IOverwolfOverlayApi extends EventEmitter {
    * });
    * ```
    *
-   * @since 2.1.0
+   * @since 2.0.5
    */
   on(
     eventName: 'shared-texture-unavailable',