@overwolf/ow-electron-packages-types 0.0.9 → 0.1.0-beta.3

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 Overwolf Ltd.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 Overwolf Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,41 +1,45 @@
-# @overwolf/ow-electron-packages-types
-
-![npm](https://img.shields.io/npm/v/@overwolf/ow-electron-packages-types)
-
-Overwolf Electron packages type definition files for autocompletion and documentation purposes.  
-
-## Installation
-
-To install this package, simply run
-
-```
-$ npm i --save-dev @overwolf/ow-electron-packages-types
-```
-
-In newer versions of ow-electron, this package should be automatically bundled in.
-
-## Usage
-
-To use this package in your Typescript project, simply import the relevant members from any relevant files
-
-```
-import "@overwolf/ow-electron-packages-types";
-```
-
-Alternatively, you can add it directly to your tsconfig file, like so:
-```
-{
-  "compilerOptions":{
-    ...,
-    "types": [
-      ...,
-      "@overwolf/ow-electron-packages-types"
-      ...
-    ]
-    ...,
-  }
-  ...
-}
-```
-
-This way, it will always be available in all of your files, even without an explicit import.
+# @overwolf/ow-electron-packages-types
+
+![npm](https://img.shields.io/npm/v/@overwolf/ow-electron-packages-types)
+
+Overwolf Electron packages type definition files for autocompletion and documentation purposes.  
+
+## Installation
+
+To install this package, simply run
+
+```
+$ npm i --save-dev @overwolf/ow-electron-packages-types
+```
+
+In newer versions of ow-electron, this package should be automatically bundled in.
+
+## Usage
+
+To use this package in your Typescript project, simply import the relevant members from any relevant files
+
+```
+import "@overwolf/ow-electron-packages-types";
+```
+
+Alternatively, you can add it directly to your tsconfig file, like so:
+```
+{
+  "compilerOptions":{
+    ...,
+    "types": [
+      ...,
+      "@overwolf/ow-electron-packages-types"
+      ...
+    ]
+    ...,
+  }
+  ...
+}
+```
+
+This way, it will always be available in all of your files, even without an explicit import.
+
+## Getting started with ow-electron packages
+
+[ow-electron packages](./docs/packages.md)

package/common/common.d.ts

@@ -0,0 +1,48 @@
+import {overwolf} from '@overwolf/ow-electron/'
+import { IOverwolfRecordingApi } from '../recorder';
+import { IOverwolfOverlayApi } from '../overlay';
+
+// -----------------------------------------------------------------------------
+export declare type GameProcessInfo = {
+  pid?: number;
+
+  fullPath: string;
+
+  commandLine?: string;
+
+  is32Bit?: boolean;
+
+  isElevated?: boolean;
+};
+
+// -----------------------------------------------------------------------------
+export declare type GameInfo = {
+  id: number;
+
+  classId: number;
+
+  name: string;
+
+  supported: boolean;
+
+  processInfo?: GameProcessInfo;
+
+  flags?: any;
+
+  type: 'Game' | 'Launcher';
+};
+
+// -----------------------------------------------------------------------------
+export interface GamesFilter {
+  all?: boolean;
+
+  includeUnsupported?: boolean;
+
+  gamesIds: number[];
+}
+
+// -----------------------------------------------------------------------------
+export interface OWPackages extends overwolf.packages.OverwolfPackageManager {
+  recorder: IOverwolfRecordingApi;
+  overlay: IOverwolfOverlayApi;
+}

package/common/index.ts

@@ -0,0 +1 @@
+export * from './common'

package/docs/packages.md

@@ -0,0 +1,23 @@
+
+# Working with ow-electron packages
+
+In order to add more/remove certain ow-electron "packages" from the project, simply edit the `overwolf.packages` array in the [package.json](/package.json) file, like so:
+
+```json
+{
+  ...
+  "overwolf": {
+    "packages": [
+      "gep",
+      "overlay",
+      "recorder"
+    ]
+  },
+  ...
+}
+```
+
+## Available packages detailed information
+* [recorder](./recorder/recorder.md)
+* [gep](./gep/game-events-provider.md)
+* [overlay](/overlay/overlay.md)

package/docs/recorder/api-specification.md

@@ -0,0 +1,95 @@
+
+# API Specification
+
+## Properties
+
+- `options`: Contains global options for debugging [RecordingAppOptions](types.md#recordingappoptions)
+
+## Methods
+
+> **Important:** It is recommended to wrap the methods in a try/catch block to handle any possible exceptions from the recording API.
+
+- `isActive()`: Checks if recording or replays status is active.
+    ```javascript
+    const active = await recorderApi.isActive();
+    ```
+
+- `queryInformation()`: Queries system information, including supported encoders and available audio/video devices and monitors.
+    ```javascript
+    const info = await recorderApi.queryInformation();
+    console.log(info.monitors);
+    ```
+
+- `registerGames(filter)`: Registers game launches, triggering the `game-launched` event for detected processes. Accepts the [GamesFilter](types.md#gamesfilter) object.
+    ```javascript
+    const gamesFilter = {
+      gameIds: [1111, 2222], // use [] for all games
+    };
+    recorderApi.registerGames(gamesFilter);
+    ```
+
+- `createSettingsBuilder(options)`: Creates the [Settings Builder](types.md#capturesettingsbuilder) object.
+    - Parameters: [CaptureSettingsOptions](types.md#capturesettingsoptions)
+
+- `startRecording(options, setting, listener)`: Starts recording based on provided settings.
+    - Parameters:
+        - [RecordingOptions](types.md#recordingoptions)
+        - [CaptureSettings](types.md#capturesettings)
+        - StopCallback with [RecordStopEventArgs](types.md#recordstopeventargs)
+
+- `stopRecording(listener)`: Stops the recording.
+    - Parameters: StopCallback with [RecordStopEventArgs](types.md#recordstopeventargs)
+
+- `splitRecording(listener)`: Manually splits the video at the moment of calling the method, creating a subfolder in the current output directory for the split videos.
+    - Parameters: SplitCallback with [SplitRecordArgs](types.md#splitrecordargs)
+
+## Events
+
+- `recording-started`: Fired when video recording starts. Returns StartCallback with [RecordEventArgs](types.md#recordeventargs).
+    ```javascript
+    recorderApi.on('recording-started', (RecordEventArgs) => {
+      console.log(RecordEventArgs.filePath);
+    });
+    ```
+
+- `recording-stopped`: Fired when video recording stops. Returns StopCallback with [RecordStopEventArgs](types.md#recordstopeventargs).
+    ```javascript
+    recorderApi.on('recording-stopped', (RecordStopEventArgs) => {
+      console.log(RecordStopEventArgs.duration);
+    });
+    ```
+
+- `recording-split`: Fired when a recording video is split (manual/size/time). Returns SplitCallback with [SplitRecordArgs](types.md#splitrecordargs).
+    ```javascript
+    recorderApi.on('recording-split', (SplitRecordArgs) => {
+      console.log(SplitRecordArgs.splitCount);
+    });
+    ```
+
+- `replays-started`: Fired when replays recording starts. Returns StartCallback with [RecordEventArgs](types.md#recordeventargs).
+    ```javascript
+    recorderApi.on('replays-started', (RecordEventArgs) => {
+      console.log(RecordEventArgs.filePath);
+    });
+    ```
+
+- `replays-stopped`: Fired when replays recording stops. Returns ReplayStopCallback with [RecordEventArgs](types.md#recordeventargs).
+    ```javascript
+    recorderApi.on('replays-stopped', (RecordEventArgs) => {
+      console.log(RecordEventArgs.filePath);
+    });
+    ```
+
+- `replay-captured`: Fired when a replay video is captured. Returns ReplayCallback with [ReplayVideo](types.md#replayvideo).
+    ```javascript
+    recorderApi.on('replay-captured', (ReplayVideo) => {
+      console.log(ReplayVideo.duration);
+    });
+    ```
+
+- `stats`: Fired at every `statsIntervalMS` (defined in RecordingAppOptions) interval. Returns [RecorderStats](types.md#recorderstats).
+    ```javascript
+    recorderApi.on('stats', (RecorderStats) => {
+      console.log(RecorderStats.cpuUsage);
+    });
+    ```