Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.

Wwise SDK 2023.1.8

Retrieves CPU usage statistics at a specific profiler capture time. This data can also be found in the Advanced Profiler, under the CPU tab. To ensure the CPU data is received, refer to ak.wwise.core.profiler.enableProfilerData. The returned data includes "Inclusive" and "Exclusive" values, where "Inclusive" refers to the time spent in the element plus the time spent in any called elements, and "Exclusive" values pertain to execution only within the element itself.

Arguments

Name	Type	Description
time *	one of:	Time in milliseconds to query for cpu 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 CPU statistics for each element.
return [...]	object	Information about the amount of CPU percentage used by each element.
return[...].elementName	string	The name of the element on which we calculate CPU usage.
return[...].id	integer	Class ID of the element.
return[...].instances	integer	An estimation of the number of instances of the element.
return[...].type	string	The type of element. For example, Codec, Source, Effect, Mixer or Sink.
return[...].percentInclusive	number	The percentage of CPU time spent in the execution of the element and those that it uses (calls).
return[...].percentExclusive	number	The percentage of CPU time spent only in the execution of the element itself.
return[...].millisecondsInclusive	number	The milliseconds of CPU time spent in the execution of the element and those that it uses (calls).
return[...].millisecondsExclusive	number	The milliseconds of CPU time spent only in the execution of the element itself.

(Required *)

Result Schema

Examples

Querying the CPU usage at a point in time.

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.

Get started with Wwise

Wwise SDK

ak.wwise.core.profiler.getCpuUsage