Version
menu_open
Wwise SDK 2019.1.11
ak.soundengine.setMultiplePositions Arguments Schema

Schema

{
"additionalProperties": false,
"required": [
"gameObject",
"positions",
"multiPositionType"
],
"type": "object",
"properties": {
"gameObject": {
"minimum": 0,
"type": "integer",
"description": "Game Object identifier.\\n A game object ID, unsigned integer 64-bit.",
"maximum": 18446744073709551615
},
"multiPositionType": {
"minimum": 0,
"type": "integer",
"maximum": 2,
"description": "Use values from <tt>AK::SoundEngine::MultiPositionType</tt>."
},
"positions": {
"items": {
"description": "Position",
"required": [
"position"
],
"maxItems": 65535,
"additionalProperties": false,
"type": "object",
"properties": {
"position": {
"additionalProperties": false,
"required": [
"orientationFront",
"orientationTop",
"position"
],
"type": "object",
"description": "A 3D position to set for the game object.",
"properties": {
"orientationTop": {
"additionalProperties": false,
"required": [
"x",
"y",
"z"
],
"type": "object",
"description": "Top orientation of the listener.",
"properties": {
"y": {
"type": "number",
"description": "Y Position."
},
"x": {
"type": "number",
"description": "X Position."
},
"z": {
"type": "number",
"description": "Z Position."
}
}
},
"position": {
"additionalProperties": false,
"required": [
"x",
"y",
"z"
],
"type": "object",
"description": "Position of the listener",
"properties": {
"y": {
"type": "number",
"description": "Y Position."
},
"x": {
"type": "number",
"description": "X Position."
},
"z": {
"type": "number",
"description": "Z Position."
}
}
},
"orientationFront": {
"additionalProperties": false,
"required": [
"x",
"y",
"z"
],
"type": "object",
"description": "Orientation of the listener.",
"properties": {
"y": {
"type": "number",
"description": "Y Position."
},
"x": {
"type": "number",
"description": "X Position."
},
"z": {
"type": "number",
"description": "Z Position."
}
}
}
}
}
}
},
"type": "array",
"description": "Array of positions to apply."
}
}
}

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