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

#include <IAudioExtensionPlugin.h>

+ Inheritance diagram for IAudioSpatializationFactory:

Public Member Functions

virtual ~IAudioSpatializationFactory ()
 
virtual FString GetDisplayName () override
 
virtual int32 GetMaxSupportedChannels ()
 
virtual TAudioSpatializationPtr CreateNewSpatializationPlugin (FAudioDevice *OwningDevice)=0
 
virtual UClass * GetCustomSpatializationSettingsClass () const
 
- Public Member Functions inherited from IAudioPluginFactory
virtual bool SupportsPlatform (const FString &PlatformName)=0
 
virtual bool IsExternalSend ()
 
virtual bool ReturnsToSubmixGraph () const
 

Static Public Member Functions

static FName GetModularFeatureName ()
 

Constructor & Destructor Documentation

◆ ~IAudioSpatializationFactory()

virtual IAudioSpatializationFactory::~IAudioSpatializationFactory ( )
inlinevirtual

Virtual destructor

Member Function Documentation

◆ CreateNewSpatializationPlugin()

virtual TAudioSpatializationPtr IAudioSpatializationFactory::CreateNewSpatializationPlugin ( FAudioDevice *  OwningDevice)
pure virtual
Returns
a new instance of your spatialization plugin, owned by a shared pointer.

◆ GetCustomSpatializationSettingsClass()

virtual UClass * IAudioSpatializationFactory::GetCustomSpatializationSettingsClass ( ) const
inlinevirtual
Returns
the UClass type of your settings for spatialization. This allows us to only pass in user settings for your plugin.

◆ GetDisplayName()

virtual FString IAudioSpatializationFactory::GetDisplayName ( )
inlineoverridevirtual

Reimplemented from IAudioPluginFactory.

◆ GetMaxSupportedChannels()

virtual int32 IAudioSpatializationFactory::GetMaxSupportedChannels ( )
inlinevirtual
Returns
the max amount of channels your plugin supports. For example, override this to return 2 to support spatializing mono and stereo sources.

◆ GetModularFeatureName()

static FName IAudioSpatializationFactory::GetModularFeatureName ( )
inlinestatic
The documentation for this class was generated from the following file: