Version

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

Schema

{
"type": "object",
"properties": {
"voicePipelineID": {
"type": "number",
"description": "The pipeline ID of the voice to get contributions from.\\n Identifies a playing voice instance ID.",
"minimum": 0
},
"bussesPipelineID": {
"type": "array",
"description": "An array of bus pipeline IDs.",
"items": {
"type": "number",
"description": "The pipeline IDs of busses belonging to a common voice path. An empty array defaults to the dry path.\\n Identifies a playing voice instance ID.",
"minimum": 0
}
},
"time": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "string",
"description": "Identify one of the global profiler cursors.",
"enum": [
"user",
"capture"
]
}
],
"description": "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."
}
},
"required": [
"voicePipelineID",
"time"
],
"additionalProperties": false
}

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