overwolf.benchmarking API

OBSOLETE

This API is no longer supported and maintained. Some of it’s methods and events might not work as intended.

This is a set of functions for querying system stats and benchmarks. These calls require administrative permissions, which the user may be prompted to grant with a UAC message which may interrupt him while playing. In order to avoid interruptions, it is recommended to ask before requesting permissions.

Methods Reference

• overwolf.benchmarking.requestHardwareInfo()
• overwolf.benchmarking.requestProcessInfo()
• overwolf.benchmarking.requestFpsInfo()
• overwolf.benchmarking.stopRequesting()
• overwolf.benchmarking.requestPermissions()

Events Reference

• overwolf.benchmarking.onHardwareInfoReady
• overwolf.benchmarking.onProcessInfoReady
• overwolf.benchmarking.onFpsInfoReady

requestHardwareInfo(interval, callback)

Version added: 0.78

Requests hardware information within a given interval.

See requestPermissions for administrative permissions instructions.

Parameter	Type	Description
interval	int	The desired maximal interval (in milliseconds) in which events will be triggered. Minimum is 500ms
callback	function	Returns with the result

Usage

Before calling this function, you should subscribe to the onHardwareInfoReady event.
The event will be triggered every X time, as you set in the requestHardwareInfo interval.

When you want to stop receiving the information, please call stopRequesting().

Example data

See the onHardwareInfoReady event.

requestProcessInfo(interval, callback)

Version added: 0.78

Requests process information within a given interval.

See requestPermissions for administrative permissions instructions.

Parameter	Type	Description
interval	int	The desired maximal interval (in milliseconds) in which events will be triggered. Minimum is 500ms
callback	function	Returns with the result

Usage

Before calling this function, you should subscribe to the onProcessInfoReady event.
The event will be triggered every X time, as you set in the requestProcessInfo interval.

When you want to stop receiving the information, please call stopRequesting().

Example data

See the onProcessInfoReady event.

requestFpsInfo(interval, callback)

Version added: 0.78

Requests game FPS information within a given interval.

Parameter	Type	Description
interval	int	The desired maximal interval (in milliseconds) in which events will be triggered. Minimum is 500ms
callback	function	Returns with the result

Usage

Before calling this function, you should subscribe to the onFpsInfoReady event.
The event will be triggered every X time, as you set in the requestFpsInfo interval.

When you want to stop receiving the information, please call stopRequesting().

Example data

See the onFpsInfoReady event.

stopRequesting()

Version added: 0.78

Stop receiving hardware/process events.

Use this when you no longer want to receive events or when you close your app.

requestPermissions(callback)

Version added: 0.78

In case Overwolf requires administrative permissions, and after prompting the user to grant more permissions, call this function and then request your desired benchmarking information.

Parameter	Type	Description
callback	function	Returns with the result

More info

Note that the some functions in the benchmarking API requires Overwolf to have Administrative permissions, and should they be missing, the callback will return 'Permissions Required'.

You will then have to ask the app user for permissions and according to the user’s choice, call requestPermissions.

It is then necessary to call the requested function (for example, requestProcessInfo) again.

onHardwareInfoReady

Version added: 0.78

Fired when hardware information is ready with a JSON containing the information.

Event data example: Success

"General": {
    "PowerPlan": "Balanced"
},
"Mainboard": {
    "Name": "ASUS P8H61-M",
    "Voltages": [{
                "Name": "CPU VCore",
                "Value": 0.968,
...

onProcessInfoReady

Version added: 0.78

Fired when process information is ready with a JSON containing the information.

Event data example: Success

The event returns the top ten processes in terms of CPU usage and Memory usage.

{
    "TopCpuUsage": [
        {
            "PrivateWorkingSet": 17674240,
            "PrecentProcessorTime": 5.703688196431727,
            "Id": 6988,
            "Name": "OverwolfBrowser#3"
        },
        {
            "PrivateWorkingSet": 16150528,
            "PrecentProcessorTime": 5.703688196431727,
            "Id": 8216,
            "Name": "OverwolfBenchmarking"
        },
        ...
    ],
    "TopMemoryUsage": [
        {
            "PrivateWorkingSet": 611196928,
            "PrecentProcessorTime": 2.851844098215878,
            "Id": 5484,
            "Name": "firefox"
        },
        {
            "PrivateWorkingSet": 141586432,
            "PrecentProcessorTime": 2.851844098215878,
            "Id": 596,
            "Name": "Overwolf"
        },
        ...
    ]
}

onFpsInfoReady

Version added: 0.78

Fired when FPS information is ready with a JSON containing the information.

Event data example: Success

If you are in a game:

{ 
    "Fps": 61 
}

If you are not in a game:

{
    "Fps":"Not in a game"
}