Version

menu_open
Wwise SDK 2023.1.2
ak.wwise.core.profiler.getRTPCs

Retrieves active RTPCs at a specific profiler capture time.

Arguments

Name Type Description
time * one of: Time in milliseconds to query for RTPCs, 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 RTPCs.
return [...] object An RTPC associated with a playing voice. Use the return options to specify which property is required.
return[...].id string The ID (GUID) of the Game Parameter, LFO, Time, Envelope or MIDI Parameter object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].name string The name of the Game Parameter, LFO, Time, Envelope or MIDI Parameter object.
The name of the object.
return[...].gameObjectId integer The Game Object associated with the RTPC scope, or AK_INVALID_GAME_OBJECT for global scope RTPCs.
A game object ID, unsigned integer 64-bit. Range: [0,18446744073709551615]
return[...].value number The value of the Game Parameter, LFO, Time, Envelope or MIDI Parameter at the cursor 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