Version
menu
Wwise SDK 2024.1.6
ak.wwise.core.profiler.getVoiceContributions Result Schema

Schema

{
"type": "object",
"additionalProperties": false,
"properties": {
"return": {
"type": "object",
"description": "The hierarchy of objects with parameters contributing to the voice, ordered from top-level parent to the voice object",
"additionalProperties": false,
"properties": {
"volume": {
"type": "number",
"description": "The volume difference applied as a contribution."
},
"LPF": {
"type": "number",
"description": "The LPF difference applied as a contribution."
},
"HPF": {
"type": "number",
"description": "The HPF difference applied as a contribution."
},
"objects": {
"type": "array",
"description": "A tree of contribution objects.",
"items": {
"type": "object",
"description": "Identifies a Voice Inspector contribution.",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "The name of the contribution."
},
"volume": {
"type": "number",
"description": "The volume difference applied."
},
"LPF": {
"type": "number",
"description": "The LPF difference applied."
},
"HPF": {
"type": "number",
"description": "The HPF difference applied."
},
"index": {
"type": "integer",
"description": "Unique (per emitter) identifier for the emitter-listener ray.\\n Unsigned Integer 32-bit.",
"minimum": 0,
"maximum": 4294967295
},
"children": {
"type": "array",
"description": "An array of child objects associated to the object.",
"items": {
"type": "object",
"description": "A voice contribution object.\\n Identifies a Voice Inspector contribution.",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "The name of the contribution."
},
"volume": {
"type": "number",
"description": "The volume difference applied."
},
"LPF": {
"type": "number",
"description": "The LPF difference applied."
},
"HPF": {
"type": "number",
"description": "The HPF difference applied."
},
"index": {
"type": "integer",
"description": "Unique (per emitter) identifier for the emitter-listener ray.\\n Unsigned Integer 32-bit.",
"minimum": 0,
"maximum": 4294967295
},
"children": {
"type": "array",
"description": "An array of child objects associated to the object.",
"items": {
"$ref": "#/definitions/voiceContributionsObject",
"description": "A voice contribution object."
}
},
"parameters": {
"type": "array",
"description": "An array of contribution parameters associated to the object.",
"items": {
"type": "object",
"description": "A contribution parameter.",
"additionalProperties": false,
"properties": {
"propertyType": {
"type": "string",
"description": "The object property affecting the voice"
},
"reason": {
"type": "string",
"description": "The reason for the parameter to affect the voice."
},
"driver": {
"type": "string",
"description": "The driving reason when a parameter is not driven by an object, or the driving object GUID."
},
"driverValue": {
"oneOf": [
{
"type": "number",
"description": "The value of the driver affecting the parameter."
},
{
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "Can be an object, e.g. for States.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
]
},
"value": {
"type": "number",
"description": "Contribution value"
}
}
}
}
}
}
},
"parameters": {
"type": "array",
"description": "An array of contribution parameters associated to the object.",
"items": {
"type": "object",
"description": "A contribution parameter.",
"additionalProperties": false,
"properties": {
"propertyType": {
"type": "string",
"description": "The object property affecting the voice"
},
"reason": {
"type": "string",
"description": "The reason for the parameter to affect the voice."
},
"driver": {
"type": "string",
"description": "The driving reason when a parameter is not driven by an object, or the driving object GUID."
},
"driverValue": {
"oneOf": [
{
"type": "number",
"description": "The value of the driver affecting the parameter."
},
{
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "Can be an object, e.g. for States.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
]
},
"value": {
"type": "number",
"description": "Contribution value"
}
}
}
}
}
}
}
},
"required": [
"volume",
"LPF",
"HPF",
"objects"
]
}
}
}

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