Set the Auxiliary Busses to route the specified game object. See AK::SoundEngine::SetGameObjectAuxSendValues.
Supported by
Graphical User Interface.
Arguments
(Required *)
Arguments Details
gameObject
description : Associated game object ID.
type : integer
minimum : 0
maximum : 18446744073709551615
auxSendValues
type : array
argsSchema / auxSendValues / ...
items
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 auxiliary bus. |
| controlValue * |
number |
Value in the range [0.0f:1.0f], send level to auxiliary bus. |
(Required *)
description : Array of AkAuxSendValue structures.
Examples :
Setting the Auxiliary Busses for a game object
Sets the Auxiliary Busses of "emitter" for "listener"s specifying the bus name and value for each.
Arguments:
{
"gameObject": 1122334,
"auxSendValues": [
{
"listener": 5566123,
"auxBus": "AuxBus1",
"controlValue": 0.6
},
{
"listener": 226486,
"auxBus": "AuxBus2",
"controlValue": 0.4
}
]
}
Result:
Detailed JSON Schema
Arguments :
{
"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 auxiliary 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
}
Options :
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Response :
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Document version : 1