Version

menu_open
Wwise SDK 2023.1.5
ak.wwise.core.profiler.getPerformanceMonitor

Retrieves the Performance Monitor statistics at a specific profiler capture time. Refer to Wwise Authoring Performance Monitor Counter Identifiers for the available counters.

Arguments

Name Type Description
time * one of: Time in milliseconds to query for Performance Monitor data, or a Time Cursor from which to acquire the time. The User Time Cursor is the one that can be manipulated by the user, while the Capture Time Cursor represents the latest time of the current capture.
integer Range: [0,*]
string Identify one of the global profiler cursors. Possible values:
  • user
  • capture

(Required *)

Arguments Schema

Result

Name Type Description
return * array Array of Performance Monitor counters.
return [...] object Performance Monitor counter.
Performance Monitor counter values.
return[...].name string name of the counter as shown in Wwise Authoring.
return[...].id string unique Id of the counter.
return[...].value number value of counter at given time.

(Required *)

Result Schema

See Also

Examples

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.


Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise