版本
menu_open

ak.soundengine.setGameObjectAuxSendValues


Set the Auxiliary Busses to route the specified game object. See AK::SoundEngine::SetGameObjectAuxSendValues.

(Required *)

Supported by

Graphical User Interface.

Arguments

Name Type Description
gameObject * integer Associated game object ID.
auxSendValues * array Array of AkAuxSendValue structures.


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 auxilliary bus.
controlValue * number Value in the range [0.0f:1.0f], send level to auxiliary bus.


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 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
}


Options :

{
    "type": "object", 
    "required": [], 
    "properties": {}, 
    "additionalProperties": false
}


Response :

{
    "type": "object", 
    "properties": {}, 
    "additionalProperties": false
}

Document version : 1

此页面对您是否有帮助？

需要技术支持？

仍有疑问？或者问题？需要更多信息？欢迎联系我们，我们可以提供帮助！

查看我们的“技术支持”页面

介绍一下自己的项目。我们会竭力为您提供帮助。

来注册自己的项目，我们帮您快速入门，不带任何附加条件！

开始 Wwise 之旅