버전

menu_open

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.

(Required *)

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.


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", 
    "required": [], 
    "properties": {}, 
    "additionalProperties": false
}


Response :

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

Document version : 1


이 페이지가 도움이 되었나요?

지원이 필요하신가요?

질문이 있으신가요? 문제를 겪고 계신가요? 더 많은 정보가 필요하신가요? 저희에게 문의해주시면 도와드리겠습니다!

지원 페이지를 방문해 주세요

작업하는 프로젝트에 대해 알려주세요. 언제든지 도와드릴 준비가 되어 있습니다.

프로젝트를 등록하세요. 아무런 조건이나 의무 사항 없이 빠른 시작을 도와드리겠습니다.

Wwise를 시작해 보세요