@overwolf/ow-electron-packages-types 1.1.5-beta.6 → 1.1.5-beta.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/types.d.ts +103 -3
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@overwolf/ow-electron-packages-types",
3
- "version": "1.1.5-beta.6",
3
+ "version": "1.1.5-beta.8",
4
4
  "description": "Type definition file for autocompletion and documentation purposes for ow-electron packages",
5
5
  "license": "MIT",
6
6
  "types": "types.d.ts",
package/types.d.ts CHANGED
@@ -3071,6 +3071,18 @@ interface EncoderSettingsNVENC extends VideoEncoderSettingsBase {
3071
3071
  */
3072
3072
  rate_control?: kNVENCEncoderRateControl;
3073
3073
 
3074
+ /**
3075
+ * Constant Quantization Parameter (CQP) level.
3076
+ *
3077
+ * Sets a fixed quality level for the entire stream. Only applies when
3078
+ * {@link rate_control} is `'CQP'`.
3079
+ *
3080
+ * Range: `1`–`51` (`1`–`63` for AV1).
3081
+ *
3082
+ * @default 20
3083
+ */
3084
+ cqp?: number;
3085
+
3074
3086
  /**
3075
3087
  * Encoding quality preset.
3076
3088
  *
@@ -3254,11 +3266,21 @@ interface EncoderSettingsAMF extends VideoEncoderSettingsBase {
3254
3266
  ffmpeg_opts?: string;
3255
3267
 
3256
3268
  /**
3257
- * Constant Peak Quantizer (CPQ) value.
3258
- * Determines the quality level when using quantizer-based rate control modes.
3269
+ * Constant Quantization Parameter (CQP) level.
3270
+ *
3271
+ * Determines the quality level for quantizer-based rate control. Only applies
3272
+ * when {@link rate_control} is `'CQP'` or `'QVBR'`.
3273
+ *
3274
+ * Range: `0`–`51` (`0`–`63` for AV1).
3259
3275
  *
3260
3276
  * @default 20
3261
3277
  */
3278
+ cqp?: number;
3279
+
3280
+ /**
3281
+ * @deprecated Use {@link cqp} instead. Retained for backward compatibility;
3282
+ * this value is ignored by the encoder.
3283
+ */
3262
3284
  cpq?: number;
3263
3285
 
3264
3286
  /**
@@ -3364,6 +3386,30 @@ interface EncoderSettingsQuickSync extends VideoEncoderSettingsBase {
3364
3386
  */
3365
3387
  rate_control?: kQuickSyncEncoderRateControl;
3366
3388
 
3389
+ /**
3390
+ * Constant Quantization Parameter (CQP) level.
3391
+ *
3392
+ * Sets a fixed quantizer for the entire stream. Only applies when
3393
+ * {@link rate_control} is `'CQP'`.
3394
+ *
3395
+ * Range: `1`–`51` (`1`–`63` for AV1).
3396
+ *
3397
+ * @default 23
3398
+ */
3399
+ cqp?: number;
3400
+
3401
+ /**
3402
+ * Intelligent Constant Quality (ICQ) level.
3403
+ *
3404
+ * Lower values yield higher quality. Only applies when
3405
+ * {@link rate_control} is `'ICQ'`.
3406
+ *
3407
+ * Range: `1`–`51`.
3408
+ *
3409
+ * @default 23
3410
+ */
3411
+ icq_quality?: number;
3412
+
3367
3413
  /**
3368
3414
  * Target usage or encoding preset that balances performance and quality.
3369
3415
  *
@@ -3455,6 +3501,18 @@ interface EncoderSettingsX264 extends VideoEncoderSettingsBase {
3455
3501
  */
3456
3502
  rate_control?: kX264EncoderRateControl;
3457
3503
 
3504
+ /**
3505
+ * Constant Rate Factor (CRF) quality level.
3506
+ *
3507
+ * Lower values yield higher quality and larger files. Only applies when
3508
+ * {@link rate_control} is `'CRF'` or `'VBR'`.
3509
+ *
3510
+ * Range: `0`–`51`.
3511
+ *
3512
+ * @default 23
3513
+ */
3514
+ crf?: number;
3515
+
3458
3516
  /**
3459
3517
  * Specifies the encoding speed/quality trade-off preset.
3460
3518
  * A slower preset provides better compression (quality per bitrate).
@@ -3768,6 +3826,7 @@ interface EncoderInformation {
3768
3826
  * const options: RecordingAppOptions = {
3769
3827
  * showDebugWindow: true,
3770
3828
  * enableDebugLogs: true,
3829
+ * maxLogFiles: 20,
3771
3830
  * };
3772
3831
  * ```
3773
3832
  */
@@ -3783,6 +3842,14 @@ interface RecordingAppOptions {
3783
3842
  * Can be used to troubleshoot issues during recording.
3784
3843
  */
3785
3844
  enableDebugLogs?: boolean;
3845
+
3846
+ /**
3847
+ * Maximum number of OBS log files to retain under the recorder's
3848
+ * `ow-obs/logs` folder. Once the number of logs exceeds this value, the
3849
+ * oldest logs are gradually pruned.
3850
+ * Must be a positive integer. Defaults to `10`.
3851
+ */
3852
+ maxLogFiles?: number;
3786
3853
  }
3787
3854
 
3788
3855
 
@@ -4985,6 +5052,33 @@ interface OverlayWindowOptions
4985
5052
  */
4986
5053
  disableHardwareAcceleration?: boolean;
4987
5054
 
5055
+ /**
5056
+ * ⚠️ BETA — this option is experimental and its behavior may change in
5057
+ * a future release.
5058
+ *
5059
+ * `true`—renders this overlay window through a GPU shared texture
5060
+ * instead of copying pixels through shared memory on every paint. The overlay
5061
+ * forwards the GPU texture handle directly to the injected game process, which
5062
+ * composites it without any CPU-side pixel copy, significantly lowering
5063
+ * per-frame CPU overhead.
5064
+ *
5065
+ * Requires hardware acceleration to be enabled and the current game to report
5066
+ * shared-texture support (see {@link GameWindowInfo.isSharedTextureSupported}).
5067
+ * The flag is silently ignored when either condition is not met, falling back
5068
+ * to the shared-memory (CPU copy) path.
5069
+ *
5070
+ * The rendering path follows the active game: when the overlay moves to a
5071
+ * different game, a shared-texture window automatically falls back to the
5072
+ * shared-memory (CPU copy) path on a game that does not support shared
5073
+ * texture, and restores the shared-texture path on a game that does — so the
5074
+ * window stays visible on every game.
5075
+ *
5076
+ * @default false
5077
+ *
5078
+ * @since 2.0.2
5079
+ */
5080
+ useSharedTexture?: boolean;
5081
+
4988
5082
  /**
4989
5083
  * Enables Chromium process isolation (sandboxing).
4990
5084
  * Used to enforce stricter security policies or prevent resource sharing between renderer processes.
@@ -5333,11 +5427,17 @@ interface GameWindowInfo {
5333
5427
 
5334
5428
  /**
5335
5429
  * Indicates if fullscreen rendering is disabled.
5336
- *
5430
+ *
5337
5431
  * Relevant only for OOPO games.
5338
5432
  * @since 1.9.0
5339
5433
  */
5340
5434
  readonly isOOPOFullscreenRenderingDisabled?: boolean;
5435
+
5436
+ /**
5437
+ * Indicates if the game supports shared-texture (GPU) overlay rendering.
5438
+ * @since 2.0.0
5439
+ */
5440
+ readonly isSharedTextureSupported?: boolean;
5341
5441
  }
5342
5442
 
5343
5443
  /**