menu
 
バージョン
2018.1.11.6987

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

menu

Wwise SDK 2018.1.11
ak.soundengine.setGameObjectAuxSendValues


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

Supported by

Graphical User Interface.

Arguments

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

(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


このページはお役に立ちましたか?

サポートは必要ですか?

ご質問や問題、ご不明点はございますか?お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう