Version

menu_open
Wwise SDK 2022.1.11
ak.wwise.core.profiler.getVoices Result Schema

Schema

{
"type": "object",
"properties": {
"return": {
"type": "array",
"description": "Array of voices.",
"items": {
"type": "object",
"description": "Voice item.\\n A playing voice. Use the return options to specify which property is required.",
"properties": {
"pipelineID": {
"type": "integer",
"description": "Pipeline ID of the voice.\\n Unsigned Integer 32-bit.",
"minimum": 0,
"maximum": 4294967295
},
"playingID": {
"type": "integer",
"description": "Playing ID of the voice.\\n Unsigned Integer 32-bit.",
"minimum": 0,
"maximum": 4294967295
},
"soundID": {
"type": "integer",
"description": "Short ID of the sound object corresponding to the voice.\\n Unsigned Integer 32-bit.",
"minimum": 0,
"maximum": 4294967295
},
"gameObjectID": {
"type": "integer",
"description": "Game Object ID corresponding to the voice.\\n Unsigned Integer 64-bit.",
"minimum": 0,
"maximum": 18446744073709551615
},
"gameObjectName": {
"type": "string",
"description": "Game Object Name corresponding to the voice."
},
"objectGUID": {
"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": "Object GUID corresponding to the voice.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"objectName": {
"type": "string",
"description": "Object Name corresponding to the voice."
},
"playTargetID": {
"type": "integer",
"description": "Short ID of the play target object corresponding to the voice.\\n Unsigned Integer 32-bit.",
"minimum": 0,
"maximum": 4294967295
},
"playTargetGUID": {
"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": "GUID of the play target object corresponding to the voice.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"playTargetName": {
"type": "string",
"description": "Name of the play target object corresponding to the voice."
},
"baseVolume": {
"type": "number",
"description": "Voice volume in dB, including HDR attenuation."
},
"gameAuxSendVolume": {
"type": "number",
"description": "Volume send to the auxiliary bus send in dB."
},
"envelope": {
"type": "number",
"description": "Current analyzed envelope value in dB. 0 if unavailable."
},
"normalizationGain": {
"type": "number",
"description": "Loudness normalization and make-up gain in dB."
},
"lowPassFilter": {
"type": "number",
"description": "Low-Pass Filter applied to the voice."
},
"highPassFilter": {
"type": "number",
"description": "High-Pass Filter applied to the voice."
},
"priority": {
"type": "integer",
"description": "Priority given to the voice.\\n Integer 8-bit.",
"minimum": -128,
"maximum": 127
},
"isStarted": {
"type": "boolean",
"description": "True if the voice has started playing, false otherwise."
},
"isVirtual": {
"type": "boolean",
"description": "True if the voice is virtual, false otherwise."
},
"isForcedVirtual": {
"type": "boolean",
"description": "True if the voice was forced as virtual, false otherwise."
}
},
"additionalProperties": false
}
}
},
"required": [
"return"
],
"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