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

package/package.json

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

package/types.d.ts

@@ -552,6 +552,37 @@ type kKnownAudioEncodersTypes =
    */
   | string;
 
+/**
+ * PCI vendor IDs of the GPU vendors that provide a hardware video encoder.
+ *
+ * Values arrive as plain numbers, not hex strings - `0x10DE` is reported (and
+ * logged) as `4318`. Comparing against either form works.
+ *
+ * | Value    | Decimal | Vendor | Encoders        |
+ * | -------- | ------- | ------ | --------------- |
+ * | `0x10DE` | `4318`  | NVIDIA | `obs_nvenc_*`   |
+ * | `0x1002` | `4098`  | AMD    | `*_texture_amf` |
+ * | `0x8086` | `32902` | Intel  | `obs_qsv11_*`   |
+ *
+ * @see {@link VideoEncoderInfo.vendorId}
+ *
+ * @example
+ * const isNvidia = encoder.vendorId === 0x10DE;
+ */
+type kGpuVendorId =
+  /**
+   * NVIDIA (4318).
+   */
+  | 0x10DE
+  /**
+   * AMD (4098).
+   */
+  | 0x1002
+  /**
+   * Intel (32902).
+   */
+  | 0x8086;
+
 /**
  * Fixed audio sample rate of 48kHz.
  *
@@ -987,8 +1018,8 @@ interface AudioEncoderInfo extends EncoderInfoBase {
  * Information for a supported video encoder.
  *
  * This interface extends `EncoderInfoBase` and adds the specific video encoder
- * type identifier. Configurable encoder settings are reported through the
- * inherited `properties` map.
+ * type identifier and, for hardware encoders, the GPU vendor. Configurable
+ * encoder settings are reported through the inherited `properties` map.
  *
  * @extends EncoderInfoBase
  *
@@ -997,6 +1028,7 @@ interface AudioEncoderInfo extends EncoderInfoBase {
  *   codec: 'h264',
  *   name: 'NVIDIA NVENC H.264',
  *   type: 'obs_nvenc_h264_tex',
+ *   vendorId: 0x10DE,
  *   properties: {
  *     bitrate: { default: 10000, description: 'Bitrate' },
  *     rate_control: {
@@ -1014,6 +1046,15 @@ interface VideoEncoderInfo extends EncoderInfoBase {
    * @see {@link kSupportedEncodersTypes}
    */
   readonly type: kSupportedEncodersTypes;
+
+  /**
+   * The PCI vendor ID of the GPU this hardware encoder runs on, matching
+   * {@link AdapterInfo.vendorId}. Absent for software (CPU) encoders such as
+   * `obs_x264`.
+   *
+   * @see {@link kGpuVendorId}
+   */
+  readonly vendorId?: kGpuVendorId;
 }
 
 
@@ -1061,8 +1102,10 @@ interface AdapterInfo {
   readonly hagsEnabledByDefault: boolean;
 
   /**
-   * The PCI vendor ID of the adapter.
-   * Common values: 0x10DE (NVIDIA), 0x1002 (AMD), 0x8086 (Intel).
+   * The PCI vendor ID of the adapter, reported as a plain number.
+   * Common values: 0x10DE (4318) NVIDIA, 0x1002 (4098) AMD, 0x8086 (32902) Intel.
+   * Other vendors are possible (e.g. virtual display adapters), so this is a
+   * `number` rather than {@link kGpuVendorId}.
    */
   readonly vendorId: number;
 
@@ -4399,7 +4442,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 +4473,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 +4820,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 +4838,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 +4897,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 +5041,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;
 }