UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FSpatializationParams Struct Reference

#include <IAudioExtensionPlugin.h>

Public Member Functions

 FSpatializationParams ()
 

Public Attributes

FVector ListenerPosition
 
FQuat ListenerOrientation
 
FVector EmitterPosition
 
FVector EmitterWorldPosition
 
FQuat EmitterWorldRotation
 
FQuat LastEmitterWorldRotation
 
FVector LeftChannelPosition
 
FVector RightChannelPosition
 
float Distance
 
float AttenuationDistance
 
float NormalizedOmniRadius
 
float NonSpatializedAmount
 
double AudioClock
 

Detailed Description

FSpatializationParams Struct for retrieving parameters needed for computing spatialization and occlusion plugins.

Constructor & Destructor Documentation

◆ FSpatializationParams()

FSpatializationParams::FSpatializationParams ( )
inline

Member Data Documentation

◆ AttenuationDistance

float FSpatializationParams::AttenuationDistance

The distance used to compute attenuation. Maybe different from the distance between listener and emitter if it's overridden.

◆ AudioClock

double FSpatializationParams::AudioClock

The time when this spatialization params was built.

◆ Distance

float FSpatializationParams::Distance

The distance between listener and emitter.

◆ EmitterPosition

FVector FSpatializationParams::EmitterPosition

The emitter position relative to listener.

◆ EmitterWorldPosition

FVector FSpatializationParams::EmitterWorldPosition

The emitter world position.

◆ EmitterWorldRotation

FQuat FSpatializationParams::EmitterWorldRotation

The emitter world rotation.

◆ LastEmitterWorldRotation

FQuat FSpatializationParams::LastEmitterWorldRotation

The emitter world rotation on callback ago.

◆ LeftChannelPosition

FVector FSpatializationParams::LeftChannelPosition

The left channel position.

◆ ListenerOrientation

FQuat FSpatializationParams::ListenerOrientation

The listener orientation.

◆ ListenerPosition

FVector FSpatializationParams::ListenerPosition

The listener position (is likely at the origin).

◆ NonSpatializedAmount

float FSpatializationParams::NonSpatializedAmount

The amount of non-spatialized this source is. 1.0 means fully 2D, 0.0 means fully 3D.

◆ NormalizedOmniRadius

float FSpatializationParams::NormalizedOmniRadius

Deprecated

◆ RightChannelPosition

FVector FSpatializationParams::RightChannelPosition

The right channel position.

The documentation for this struct was generated from the following file: