arrow_right Table of Contents

Other Documentation

Wwise SDK 2021.1.8

◆ SetListenerSpatialization()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::SetListenerSpatialization ( AkGameObjectID  in_uListenerID,
bool  in_bSpatialized,
AkChannelConfig  in_channelConfig,
AK::SpeakerVolumes::VectorPtr  in_pVolumeOffsets = NULL 

Sets a listener's spatialization parameters. This lets you define listener-specific volume offsets for each audio channel. If in_bSpatialized is false, only in_pVolumeOffsets is used for this listener (3D positions have no effect on the speaker distribution). Otherwise, in_pVolumeOffsets is added to the speaker distribution computed for this listener. Use helper functions of AK::SpeakerVolumes to manipulate the vector of volume offsets in_pVolumeOffsets.

  • If a sound is mixed into a bus that has a different speaker configuration than in_channelConfig, standard up/downmix rules apply.
  • Sounds with 3D Spatialization set to None will not be affected by these parameters.
AK_Success if message was successfully posted to sound engine queue AK_InvalidFloatValue if the value specified was NaN or Inf AK_InsufficientMemory if there wasn't enough memory in the message queue
See also
in_uListenerID Listener game object ID
in_bSpatialized Spatialization toggle (True : enable spatialization, False : disable spatialization)
in_channelConfig Channel configuration associated with volumes in_pVolumeOffsets. Ignored if in_pVolumeOffsets is NULL.
in_pVolumeOffsets Per-speaker volume offset, in dB. See AkSpeakerVolumes.h for how to manipulate this vector.