|
Wwise SDK 2025.1.0
|
Initialization settings of the spatial audio module. More...
#include <AkSpatialAudioTypes.h>
Public Member Functions | |
| AkSpatialAudioInitSettings () | |
Public Attributes | |
| AkUInt32 | uMaxSoundPropagationDepth |
| Maximum number of portals that sound can propagate through; must be less than or equal to AK_MAX_SOUND_PROPAGATION_DEPTH. More... | |
| AkReal32 | fMovementThreshold |
| Amount that an emitter or listener has to move to trigger a validation of reflections/diffraction. Larger values can reduce the CPU load at the cost of reduced accuracy. Note that the ray tracing itself is not affected by this value. Rays are cast each time a Spatial Audio update is executed. More... | |
| AkUInt32 | uNumberOfPrimaryRays |
| The number of primary rays used in the ray tracing engine. A larger number of rays will increase the chances of finding reflection and diffraction paths, but will result in higher CPU usage. More... | |
| AkUInt32 | uMaxReflectionOrder |
| Maximum reflection order [1, 4] - the number of 'bounces' in a reflection path. A high reflection order renders more details at the expense of higher CPU usage. More... | |
| AkUInt32 | uMaxDiffractionOrder |
| AkUInt32 | uMaxDiffractionPaths |
| AkUInt32 | uMaxGlobalReflectionPaths |
| AkUInt32 | uMaxEmitterRoomAuxSends |
| Set to 1 to only allow emitters to send directly to their current room, and to the room a listener is transitioning to if inside a portal. Set to 0 to disable the limit. More... | |
| AkUInt32 | uDiffractionOnReflectionsOrder |
| AkReal32 | fMaxDiffractionAngleDegrees |
| AkReal32 | fMaxPathLength |
| AkReal32 | fCPULimitPercentage |
| Defines the targeted max computation time allocated for spatial audio. Defined as a percentage [0, 100] of the current audio frame. When the value is different from 0, Spatial Audio adapts dynamically the load balancing spread (see AkSpatialAudioInitSettings::uLoadBalancingSpread) according to current CPU usage and the specified CPU limit. Set to 0 to disable the dynamic load balancing spread computation. More... | |
| AkReal32 | fSmoothingConstantMs |
| AkReal32 | fAdjacentRoomBleed |
| AkUInt32 | uLoadBalancingSpread |
| Spread the computation of paths on uLoadBalancingSpread frames [1..[. When uLoadBalancingSpread is set to 1, no load balancing is done. Values greater than 1 indicate the computation of paths will be spread on this number of frames. When CPU limit is active (see AkSpatialAudioInitSettings::fCPULimitPercentage), this setting represents the upper bound spread used by the dynamic load balancing instead of a fixed value. More... | |
| bool | bEnableGeometricDiffractionAndTransmission |
| bool | bCalcEmitterVirtualPosition |
| An emitter that is diffracted through a portal or around geometry will have its apparent or virtual position calculated by Wwise Spatial Audio and passed on to the sound engine. More... | |
| enum AkTransmissionOperation | eTransmissionOperation |
| The operation used to determine transmission loss on direct paths. More... | |
| AkUInt32 | uClusteringMinPoints |
| AkReal32 | fClusteringMaxDistance |
| Max distance between emitters to be considered as neighbors. This distance is specified for the reference distance defined by fClusteringDeadZoneDistance. Default value is 5.0. More... | |
| AkReal32 | fClusteringDeadZoneDistance |
| Defines a dead zone around the listener where no emitters are clusters. Default value is 10.0. More... | |
Initialization settings of the spatial audio module.
Definition at line 219 of file AkSpatialAudioTypes.h.
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise