@overwolf/ow-electron-packages-types 1.1.14-beta.3 → 1.1.14-beta.4

package/package.json

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

package/types.d.ts

@@ -4399,7 +4399,7 @@ interface RecordingAppOptions {
  * | Code    | Name                         | Description                                                                      |
  * | ------- | ---------------------------- | -------------------------------------------------------------------------------- |
  * | `-1001` | `Unknown`                    | Generic unknown error.                                                           |
- * | `-1000` | `ProcessTerminated`          | OBS process crashed.                                                             |
+ * | `-1000` | `ProcessTerminated`          | OBS process ended: a crash, or a restart after a hung stop.                      |
  * | `-999`  | `MissingBinaries`            | Missing binaries required for recording.                                         |
  * | `-998`  | `ConnectionOBSError`         | Failed to connect to the OBS process.                                            |
  * | `-997`  | `AlreadyRunning`             | Operation attempted while recording is already running.                          |
@@ -4430,7 +4430,7 @@ interface RecordingAppOptions {
  */
 type ErrorCode =
   | -1001 // Generic unknown error. 'Unknown'
-  | -1000 // OBS process crashed. 'ProcessTerminated'
+  | -1000 // OBS process ended: a crash, or a restart after a hung stop. 'ProcessTerminated'
   | -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'
@@ -4777,6 +4777,7 @@ interface RecordStopEventArgs extends RecordEventArgs {
   /**
    * The total duration of the video in milliseconds,
    * available when the recording ends successfully.
+   * `0` when OBS ended before the recording stopped (`ProcessTerminated`).
    */
   duration?: number;
 
@@ -4794,6 +4795,7 @@ interface RecordStopEventArgs extends RecordEventArgs {
   /**
    * The epoch timestamp (in milliseconds) representing
    * when the recording started.
+   * `0` when OBS ended before the recording stopped (`ProcessTerminated`).
    */
   startTimeEpoch?: number;
 }
@@ -4852,11 +4854,13 @@ interface SplitRecordArgs extends RecordEventArgs {
 interface ReplayVideo extends RecordEventArgs {
   /**
    * Duration of the replay video in milliseconds.
+   * `0` when OBS ended before the replay was saved (`ProcessTerminated`).
    */
   duration: number;
 
   /**
    * Epoch UTC timestamp (in milliseconds) of when the replay started (first frame).
+   * `0` when OBS ended before the replay was saved (`ProcessTerminated`).
    */
   startTimeEpoch: number;
 }
@@ -4994,7 +4998,8 @@ interface PerformanceWarningArgs {
   skippedFrames: number;
 
   /**
-   * Number of frames measured.
+   * Number of frames measured: frames sent to the encoder for `encoding-lag`,
+   * rendered frames for `rendering-lag`.
    */
   totalFrames: number;
 }