UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IAudioReverb Class Referenceabstract

#include <IAudioExtensionPlugin.h>

Public Member Functions

virtual ~IAudioReverb ()
 
virtual void Initialize (const FAudioPluginInitializationParams InitializationParams)
 
virtual void Shutdown ()
 
virtual void OnDeviceShutdown (FAudioDevice *AudioDevice)
 
virtual void OnInitSource (const uint32 SourceId, const FName &AudioComponentUserId, const uint32 NumChannels, UReverbPluginSourceSettingsBase *InSettings)=0
 
virtual void OnReleaseSource (const uint32 SourceId)=0
 
virtual FSoundEffectSubmixPtr GetEffectSubmix ()=0
 
virtual USoundSubmixLoadSubmix ()
 
virtual USoundSubmixGetSubmix ()=0
 
virtual void ProcessSourceAudio (const FAudioPluginSourceInputData &InputData, FAudioPluginSourceOutputData &OutputData)
 

Constructor & Destructor Documentation

◆ ~IAudioReverb()

virtual IAudioReverb::~IAudioReverb ( )
inlinevirtual

Virtual destructor

Member Function Documentation

◆ GetEffectSubmix()

virtual FSoundEffectSubmixPtr IAudioReverb::GetEffectSubmix ( )
pure virtual

Returns the plugin-managed effect submix instance

◆ GetSubmix()

virtual USoundSubmix * IAudioReverb::GetSubmix ( )
pure virtual

Returns the plugin-managed effect submix

◆ Initialize()

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

Initialize the reverb plugin with the same rate and number of sources.

◆ LoadSubmix()

virtual USoundSubmix * IAudioReverb::LoadSubmix ( )
inlinevirtual

◆ OnDeviceShutdown()

virtual void IAudioReverb::OnDeviceShutdown ( FAudioDevice AudioDevice)
inlinevirtual

◆ OnInitSource()

virtual void IAudioReverb::OnInitSource ( const uint32  SourceId,
const FName AudioComponentUserId,
const uint32  NumChannels,
UReverbPluginSourceSettingsBase InSettings 
)
pure virtual

Called when a source is assigned to a voice.

◆ OnReleaseSource()

virtual void IAudioReverb::OnReleaseSource ( const uint32  SourceId)
pure virtual

Called when a source is done playing and is released.

◆ ProcessSourceAudio()

virtual void IAudioReverb::ProcessSourceAudio ( const FAudioPluginSourceInputData InputData,
FAudioPluginSourceOutputData OutputData 
)
inlinevirtual

Processes audio with the given input and output data structs.

◆ Shutdown()

virtual void IAudioReverb::Shutdown ( )
inlinevirtual

Shuts down the audio plugin.


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