UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IAudioOcclusion Class Reference

#include <IAudioExtensionPlugin.h>

Public Member Functions

virtual ~IAudioOcclusion ()
 
virtual void Initialize (const FAudioPluginInitializationParams InitializationParams)
 
virtual void Shutdown ()
 
virtual void OnInitSource (const uint32 SourceId, const FName &AudioComponentUserId, const uint32 NumChannels, UOcclusionPluginSourceSettingsBase *InSettings)
 
virtual void OnReleaseSource (const uint32 SourceId)
 
virtual void ProcessAudio (const FAudioPluginSourceInputData &InputData, FAudioPluginSourceOutputData &OutputData)
 

Constructor & Destructor Documentation

◆ ~IAudioOcclusion()

virtual IAudioOcclusion::~IAudioOcclusion ( )
inlinevirtual

Virtual destructor

Member Function Documentation

◆ Initialize()

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

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

◆ OnInitSource()

virtual void IAudioOcclusion::OnInitSource ( const uint32  SourceId,
const FName AudioComponentUserId,
const uint32  NumChannels,
UOcclusionPluginSourceSettingsBase InSettings 
)
inlinevirtual

Called when a source is assigned to a voice.

◆ OnReleaseSource()

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

Called when a source is done playing and is released.

◆ ProcessAudio()

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

Processes audio with the given input and output data structs.

◆ Shutdown()

virtual void IAudioOcclusion::Shutdown ( )
inlinevirtual

Shuts down the audio plugin.


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