@overwolf/ow-electron-packages-types 1.1.2-beta.5 → 1.1.2-beta.7
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.
- package/package.json +2 -2
- package/types.d.ts +64 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@overwolf/ow-electron-packages-types",
|
|
3
|
-
"version": "1.1.2-beta.
|
|
3
|
+
"version": "1.1.2-beta.7",
|
|
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",
|
|
@@ -37,4 +37,4 @@
|
|
|
37
37
|
"dependencies": {
|
|
38
38
|
"glob": "^13.0.0"
|
|
39
39
|
}
|
|
40
|
-
}
|
|
40
|
+
}
|
package/types.d.ts
CHANGED
|
@@ -940,6 +940,38 @@ interface VideoInformation {
|
|
|
940
940
|
readonly defaultEncoder: kSupportedEncodersTypes;
|
|
941
941
|
}
|
|
942
942
|
|
|
943
|
+
/**
|
|
944
|
+
* Information about the current Xbox Game DVR state on the system.
|
|
945
|
+
*
|
|
946
|
+
* Xbox Game DVR captures game video in the background and can interfere with
|
|
947
|
+
* recording. This interface reports whether it is active and the underlying
|
|
948
|
+
* registry values that drive it.
|
|
949
|
+
*
|
|
950
|
+
* @example
|
|
951
|
+
* const dvr: XboxDVRInfo = {
|
|
952
|
+
* enabled: true,
|
|
953
|
+
* appCaptureEnabled: true,
|
|
954
|
+
* gameDVREnabled: false
|
|
955
|
+
* };
|
|
956
|
+
*/
|
|
957
|
+
interface XboxDVRInfo {
|
|
958
|
+
/**
|
|
959
|
+
* `true` if Xbox Game DVR is active via either capture path
|
|
960
|
+
* (`appCaptureEnabled || gameDVREnabled`).
|
|
961
|
+
*/
|
|
962
|
+
readonly enabled: boolean;
|
|
963
|
+
|
|
964
|
+
/**
|
|
965
|
+
* The `AppCaptureEnabled` registry value.
|
|
966
|
+
*/
|
|
967
|
+
readonly appCaptureEnabled: boolean;
|
|
968
|
+
|
|
969
|
+
/**
|
|
970
|
+
* The `GameDVR_Enabled` registry value.
|
|
971
|
+
*/
|
|
972
|
+
readonly gameDVREnabled: boolean;
|
|
973
|
+
}
|
|
974
|
+
|
|
943
975
|
/**
|
|
944
976
|
* Information about the complete recording configuration for the current system.
|
|
945
977
|
*
|
|
@@ -975,6 +1007,13 @@ interface RecordingInformation {
|
|
|
975
1007
|
* @see MonitorInfo
|
|
976
1008
|
*/
|
|
977
1009
|
monitors: MonitorInfo[];
|
|
1010
|
+
|
|
1011
|
+
/**
|
|
1012
|
+
* The current Xbox Game DVR state on the system.
|
|
1013
|
+
*
|
|
1014
|
+
* @see XboxDVRInfo
|
|
1015
|
+
*/
|
|
1016
|
+
xboxDVR: XboxDVRInfo;
|
|
978
1017
|
}
|
|
979
1018
|
|
|
980
1019
|
|
|
@@ -4340,10 +4379,15 @@ interface IOverwolfRecordingApi {
|
|
|
4340
4379
|
readonly version: string;
|
|
4341
4380
|
|
|
4342
4381
|
/**
|
|
4343
|
-
* Path to ffmpeg
|
|
4382
|
+
* Path to ffmpeg executable
|
|
4344
4383
|
*/
|
|
4345
4384
|
readonly ffmpegPath: string;
|
|
4346
4385
|
|
|
4386
|
+
/**
|
|
4387
|
+
* Path to ffprobe executable
|
|
4388
|
+
*/
|
|
4389
|
+
readonly ffprobePath: string;
|
|
4390
|
+
|
|
4347
4391
|
/**
|
|
4348
4392
|
* Path to OBS binaries folder.
|
|
4349
4393
|
*/
|
|
@@ -4367,12 +4411,31 @@ interface IOverwolfRecordingApi {
|
|
|
4367
4411
|
/**
|
|
4368
4412
|
* Queries supported encoders, audio/video devices, and configuration options.
|
|
4369
4413
|
*
|
|
4414
|
+
* The result also includes the current Xbox Game DVR state (`xboxDVR`).
|
|
4415
|
+
*
|
|
4370
4416
|
* @param overrideCache If `true`, bypasses cached result and queries OBS directly.
|
|
4371
4417
|
* @returns A promise that resolves to the full recording capability information.
|
|
4372
4418
|
* @see {@link RecordingInformation}
|
|
4373
4419
|
*/
|
|
4374
4420
|
queryInformation(overrideCache?: boolean): Promise<RecordingInformation>;
|
|
4375
4421
|
|
|
4422
|
+
/**
|
|
4423
|
+
* Returns whether Xbox Game DVR is enabled, checking both the
|
|
4424
|
+
* `GameDVR_Enabled` and `AppCaptureEnabled` registry values.
|
|
4425
|
+
*
|
|
4426
|
+
* @returns A promise that resolves to the current Xbox Game DVR state.
|
|
4427
|
+
* @see {@link XboxDVRInfo}
|
|
4428
|
+
*/
|
|
4429
|
+
isXboxDVREnabled(): Promise<XboxDVRInfo>;
|
|
4430
|
+
|
|
4431
|
+
/**
|
|
4432
|
+
* Disables Xbox Game DVR by setting `AppCaptureEnabled` and
|
|
4433
|
+
* `GameDVR_Enabled` to `0` in the registry.
|
|
4434
|
+
*
|
|
4435
|
+
* @returns A promise that resolves once the values have been written.
|
|
4436
|
+
*/
|
|
4437
|
+
disableXboxDVR(): Promise<void>;
|
|
4438
|
+
|
|
4376
4439
|
/**
|
|
4377
4440
|
* Creates a capture settings builder instance to configure video/audio sources.
|
|
4378
4441
|
*
|