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

#include <IAudioExtensionPlugin.h>

Public Member Functions

virtual ~IAudioSourceDataOverride ()
 
virtual void Initialize (const FAudioPluginInitializationParams InitializationParams)
 
virtual void OnInitSource (const uint32 SourceId, const FName &AudioComponentUserId, USourceDataOverridePluginSourceSettingsBase *InSettings)
 
virtual void OnReleaseSource (const uint32 SourceId)
 
virtual void GetSourceDataOverrides (const uint32 SourceId, const FTransform &InListenerTransform, FWaveInstance *InOutWaveInstance)
 
virtual void OnAllSourcesProcessed ()
 

Detailed Description

Interface to allow a plugin to override a sound's actual position and simulate propagation (e.g. traversal around corners, etc).

Constructor & Destructor Documentation

◆ ~IAudioSourceDataOverride()

virtual IAudioSourceDataOverride::~IAudioSourceDataOverride ( )
inlinevirtual

Virtual destructor

Member Function Documentation

◆ GetSourceDataOverrides()

virtual void IAudioSourceDataOverride::GetSourceDataOverrides ( const uint32  SourceId,
const FTransform &  InListenerTransform,
FWaveInstance *  InOutWaveInstance 
)
inlinevirtual

Allows this plugin to override any source data. Called per audio source before any other parameters are updated on sound sources.

◆ Initialize()

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

Initializes the source data override plugin with the given buffer length.

◆ OnAllSourcesProcessed()

virtual void IAudioSourceDataOverride::OnAllSourcesProcessed ( )
inlinevirtual

Called when all sources have finished processing.

◆ OnInitSource()

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

Called when a source is assigned to a voice.

◆ OnReleaseSource()

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

Called when a source is done playing and is released.

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