Version

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

Retrieves all parameters affecting voice volume, highpass and lowpass for a voice path, resolved from pipeline IDs.

Arguments

Name Type Description
voicePipelineID * number The pipeline ID of the voice to get contributions from.
Identifies a playing voice instance ID. Range: [0,*]
bussesPipelineID array An array of bus pipeline IDs.
bussesPipelineID [...] number The pipeline IDs of busses belonging to a common voice path. An empty array defaults to the dry path.
Identifies a playing voice instance ID. Range: [0,*]
time * one of: Time in milliseconds to query for voices, 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 object The hierarchy of objects with parameters contributing to the voice, ordered from top-level parent to the voice object
return.volume number The volume difference applied as a contribution.
return.LPF number The LPF difference applied as a contribution.
return.HPF number The HPF difference applied as a contribution.
return.objects array A tree of contribution objects.
return.objects [...] object Identifies a Voice Inspector contribution.
return.objects[...].name string The name of the contribution.
return.objects[...].volume number The volume difference applied.
return.objects[...].LPF number The LPF difference applied.
return.objects[...].HPF number The HPF difference applied.
return.objects[...].children array An array of child objects associated to the object.
return.objects[...].children [...] A voice contribution object.
return.objects[...].parameters array An array of contribution parameters associated to the object.
return.objects[...].parameters [...] object A contribution parameter.
return.objects[...].parameters[...].propertyType string The object property affecting the voice
return.objects[...].parameters[...].reason string The reason for the parameter to affect the voice.
return.objects[...].parameters[...].driver one of:
string The driving object GUID.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
string The driving reason when a parameter is not driven by an object.
return.objects[...].parameters[...].driverValue one of:
number The value of the driver affecting the parameter.
string Can be an object, e.g. for States.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return.objects[...].parameters[...].value number Contribution value

Result Schema

See Also

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