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

#include <IAudioExtensionPlugin.h>

Public Member Functions

virtual ~IAudioSpatialization ()
 
virtual void Shutdown ()
 
virtual void OnDeviceShutdown (FAudioDevice *AudioDevice)
 
virtual void SetSpatializationParameters (uint32 SourceId, const FSpatializationParams &Params)
 
virtual void GetSpatializationParameters (uint32 SourceId, FSpatializationParams &OutParams)
 
virtual void InitializeSpatializationEffect (uint32 BufferLength)
 
virtual void ProcessSpatializationForVoice (uint32 SourceId, float *InSamples, float *OutSamples, const FVector &Position)
 
virtual void ProcessSpatializationForVoice (uint32 SourceId, float *InSamples, float *OutSamples)
 
virtual void OnInitSource (const uint32 SourceId, const FName &AudioComponentUserId, USpatializationPluginSourceSettingsBase *InSettings)
 
virtual void OnInitSource (const uint32 SourceId, const FName &AudioComponentUserId, const uint32 NumChannels, USpatializationPluginSourceSettingsBase *InSettings)
 
virtual void OnReleaseSource (const uint32 SourceId)
 
virtual void ProcessAudio (const FAudioPluginSourceInputData &InputData, FAudioPluginSourceOutputData &OutputData)
 
virtual void OnAllSourcesProcessed ()
 
virtual bool IsSpatializationEffectInitialized () const
 
virtual void Initialize (const FAudioPluginInitializationParams InitializationParams)
 
virtual bool CreateSpatializationEffect (uint32 SourceId)
 
virtual void * GetSpatializationEffect (uint32 SourceId)
 

Detailed Description

IAudioSpatialization

This class represents instances of a plugin that will process spatialization for a stream of audio. Currently used to process a mono-stream through an HRTF spatialization algorithm into a stereo stream. This algorithm contains an audio effect assigned to every VoiceId (playing sound instance). It assumes the effect is updated in the audio engine update loop with new position information.

Constructor & Destructor Documentation

◆ ~IAudioSpatialization()

virtual IAudioSpatialization::~IAudioSpatialization ( )
inlinevirtual

Virtual destructor

Member Function Documentation

◆ CreateSpatializationEffect()

virtual bool IAudioSpatialization::CreateSpatializationEffect ( uint32  SourceId)
inlinevirtual

Creates an audio spatialization effect.

◆ GetSpatializationEffect()

virtual void * IAudioSpatialization::GetSpatializationEffect ( uint32  SourceId)
inlinevirtual

Returns the spatialization effect for the given voice id.

◆ GetSpatializationParameters()

virtual void IAudioSpatialization::GetSpatializationParameters ( uint32  SourceId,
FSpatializationParams &  OutParams 
)
inlinevirtual

DEPRECATED: Gets the spatialization effect parameters.

◆ Initialize()

virtual void IAudioSpatialization::Initialize ( const FAudioPluginInitializationParams  InitializationParams)
inlinevirtual

Initializes the spatialization plugin with the given buffer length.

◆ InitializeSpatializationEffect()

virtual void IAudioSpatialization::InitializeSpatializationEffect ( uint32  BufferLength)
inlinevirtual

DEPRECATED: Initializes the spatialization effect with the given buffer length.

◆ IsSpatializationEffectInitialized()

virtual bool IAudioSpatialization::IsSpatializationEffectInitialized ( ) const
inlinevirtual

Returns whether or not the spatialization effect has been initialized

◆ OnAllSourcesProcessed()

virtual void IAudioSpatialization::OnAllSourcesProcessed ( )
inlinevirtual

Called when all sources have finished processing.

◆ OnDeviceShutdown()

virtual void IAudioSpatialization::OnDeviceShutdown ( FAudioDevice *  AudioDevice)
inlinevirtual

◆ OnInitSource() [1/2]

virtual void IAudioSpatialization::OnInitSource ( const uint32  SourceId,
const FName &  AudioComponentUserId,
const uint32  NumChannels,
USpatializationPluginSourceSettingsBase *  InSettings 
)
inlinevirtual

◆ OnInitSource() [2/2]

virtual void IAudioSpatialization::OnInitSource ( const uint32  SourceId,
const FName &  AudioComponentUserId,
USpatializationPluginSourceSettingsBase *  InSettings 
)
inlinevirtual

Called when a source is assigned to a voice.

◆ OnReleaseSource()

virtual void IAudioSpatialization::OnReleaseSource ( const uint32  SourceId)
inlinevirtual

Called when a source is done playing and is released.

◆ ProcessAudio()

virtual void IAudioSpatialization::ProcessAudio ( const FAudioPluginSourceInputData &  InputData,
FAudioPluginSourceOutputData &  OutputData 
)
inlinevirtual

Processes audio with the given input and output data structs.

◆ ProcessSpatializationForVoice() [1/2]

virtual void IAudioSpatialization::ProcessSpatializationForVoice ( uint32  SourceId,
float *  InSamples,
float *  OutSamples 
)
inlinevirtual

DEPRECATED: Uses the given HRTF algorithm to spatialize a mono audio stream, assumes the parameters have already been set before processing.

◆ ProcessSpatializationForVoice() [2/2]

virtual void IAudioSpatialization::ProcessSpatializationForVoice ( uint32  SourceId,
float *  InSamples,
float *  OutSamples,
const FVector &  Position 
)
inlinevirtual

DEPRECATED: Uses the given HRTF algorithm to spatialize a mono audio stream.

◆ SetSpatializationParameters()

virtual void IAudioSpatialization::SetSpatializationParameters ( uint32  SourceId,
const FSpatializationParams &  Params 
)
inlinevirtual

DEPRECATED: sets the spatialization effect parameters.

◆ Shutdown()

virtual void IAudioSpatialization::Shutdown ( )
inlinevirtual

Shuts down the audio plugin.

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