目次

Wwise SDK 2018.1.11
ak.soundengine.setListenerSpatialization


Set a listener's spatialization parameters. This lets you define listener-specific volume offsets for each audio channel. See AK::SoundEngine::SetListenerSpatialization.

Supported by

Graphical User Interface.

Arguments

Name Type Description
listener * integer Listener game object ID.
spatialized * boolean Spatialization toggle (true: enable spatialization, false: disable spatialization).
channelConfig * integer Channel configuration associated with volumeOffsets. Use AK::AkChannelConfig::Serialize to serialize the value.
volumeOffsets * array Per-speaker volume offset, in dB. See AkSpeakerVolumes.h for how to manipulate this array.

(Required *)

Arguments Details


listener

description : Listener game object ID.
type : integer
minimum : 0
maximum : 18446744073709551615

spatialized

type : boolean
description : Spatialization toggle (true: enable spatialization, false: disable spatialization).

channelConfig

description : Channel configuration associated with volumeOffsets. Use AK::AkChannelConfig::Serialize to serialize the value.
type : integer
minimum : 0
maximum : 4294967295

volumeOffsets

type : array

argsSchema / volumeOffsets / ...

items

type : number
maxItems : 4294967295
description : Per-speaker volume offset, in dB. See AkSpeakerVolumes.h for how to manipulate this array.


Examples :

Setting the listener spacialization.

Sets the spacialization for "listener" using "volumeOffsets" to pan to the left.

Arguments:

{
"listener": 555,
"spatialized": false,
"channelConfig": 12546,
"volumeOffsets": [
0.0,
-96.3
]
}

Result:

{}


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"listener": {
"description": "Listener game object ID.",
"type": "integer",
"minimum": 0,
"maximum": 18446744073709551615
},
"spatialized": {
"type": "boolean",
"description": "Spatialization toggle (true: enable spatialization, false: disable spatialization)."
},
"channelConfig": {
"description": "Channel configuration associated with volumeOffsets. Use AK::AkChannelConfig::Serialize to serialize the value.",
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"volumeOffsets": {
"type": "array",
"items": {
"type": "number",
"maxItems": 4294967295
},
"description": "Per-speaker volume offset, in dB. See AkSpeakerVolumes.h for how to manipulate this array."
}
},
"required": [
"listener",
"spatialized",
"channelConfig",
"volumeOffsets"
],
"additionalProperties": false
}


Options :

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


Response :

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

Document version : 1