버전

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를 시작해 보세요