menu
Version
2017.1.9.6501
2024.1.6.8842
2023.1.14.8770
2025.1.0.8897
2022.1.19.8584
2021.1.14.8108
2019.2.15.7667
2019.1.11.7296
2018.1.11.6987
2017.2.10.6745
2017.1.9.6501
2016.2.6.6153
2015.1.9.5624
2024.1.6.8842
2023.1.14.8770
2025.1.0.8897
2022.1.19.8584
2021.1.14.8108
2019.2.15.7667
2019.1.11.7296
2018.1.11.6987
2017.2.10.6745
2017.1.9.6501
2016.2.6.6153
2015.1.9.5624
Set the Auxiliary Busses to route the specified game object. See AK::SoundEngine::SetGameObjectAuxSendValues.
(Required *)
Graphical User Interface.
| Name | Type | Description |
|---|---|---|
| gameObject * | integer | Associated game object ID. |
| auxSendValues * | array | Array of AkAuxSendValue structures. |
description : Associated game object ID.
type : integer
minimum : 0
maximum : 18446744073709551615
type : array
argsSchema / auxSendValues / ...
maxItems : 4
type : object
| Name | Type | Description |
|---|---|---|
| listener * | integer | Game object ID of the listener associated with this send. |
| auxBus * | Either the ID (GUID), name or short ID of the auxilliary bus. | |
| controlValue * | number | Value in the range [0.0f:1.0f], send level to auxiliary bus. |
description : Array of AkAuxSendValue structures.
Sets the Auxiliary Busses of "emitter" for "listener"s specifying the bus name and value for each.
{
"gameObject": 1122334,
"auxSendValues": [
{
"listener": 5566123,
"auxBus": "AuxBus1",
"controlValue": 0.6
},
{
"listener": 226486,
"auxBus": "AuxBus2",
"controlValue": 0.4
}
]
}
{}
{
"type": "object",
"properties": {
"gameObject": {
"description": "Associated game object ID.",
"type": "integer",
"minimum": 0,
"maximum": 18446744073709551615
},
"auxSendValues": {
"type": "array",
"items": {
"maxItems": 4,
"type": "object",
"properties": {
"listener": {
"description": "Game object ID of the listener associated with this send.",
"type": "integer",
"minimum": 0,
"maximum": 18446744073709551615
},
"auxBus": {
"description": "Either the ID (GUID), name or short ID of the auxilliary bus.",
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z_]+[a-zA-Z_0-9]*$"
},
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
]
},
"controlValue": {
"type": "number",
"description": "Value in the range [0.0f:1.0f], send level to auxiliary bus."
}
},
"required": [
"listener",
"auxBus",
"controlValue"
],
"additionalProperties": false
},
"description": "Array of AkAuxSendValue structures."
}
},
"required": [
"gameObject",
"auxSendValues"
],
"additionalProperties": false
}
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Document version : 1
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise