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

#include <IAudioModulation.h>

+ Inheritance diagram for IAudioModulationManager:

Public Member Functions

virtual ~IAudioModulationManager ()=default
 
virtual void Initialize (const FAudioPluginInitializationParams &InitializationParams)=0
 
virtual void OnAuditionEnd ()=0
 
virtual bool OnPostHelp (FCommonViewportClient *ViewportClient, const TCHAR *Stream)=0
 
virtual int32 OnRenderStat (FViewport *Viewport, FCanvas *Canvas, int32 X, int32 Y, const UFont &Font, const FVector *ViewLocation, const FRotator *ViewRotation)=0
 
virtual bool OnToggleStat (FCommonViewportClient *ViewportClient, const TCHAR *Stream)=0
 
virtual void ProcessModulators (const double InElapsed)=0
 UE_BUILD_SHIPPING.
 
virtual void UpdateModulator (const USoundModulatorBase &InModulator)=0
 
- Public Member Functions inherited from TSharedFromThis< IAudioModulationManager >
TSharedRef< IAudioModulationManager, Mode > AsShared ()
 
TSharedRef< IAudioModulationManager const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< IAudioModulationManager, Mode > AsWeak ()
 
TWeakPtr< IAudioModulationManager const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Protected Member Functions

virtual void RegisterModulator (uint32 InHandleId, Audio::FModulatorId InModulatorId)=0
 
virtual bool GetModulatorValue (const Audio::FModulatorHandle &ModulatorHandle, float &OutValue) const =0
 
virtual bool GetModulatorValueThreadSafe (const Audio::FModulatorHandle &ModulatorHandle, float &OutValue) const =0
 
virtual void UnregisterModulator (const Audio::FModulatorHandle &InHandle)=0
 
- Protected Member Functions inherited from TSharedFromThis< IAudioModulationManager >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThis & operator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Additional Inherited Members

- Static Protected Member Functions inherited from TSharedFromThis< IAudioModulationManager >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Constructor & Destructor Documentation

◆ ~IAudioModulationManager()

virtual IAudioModulationManager::~IAudioModulationManager ( )
virtualdefault

Virtual destructor

Member Function Documentation

◆ GetModulatorValue()

virtual bool IAudioModulationManager::GetModulatorValue ( const Audio::FModulatorHandle &  ModulatorHandle,
float &  OutValue 
) const
protectedpure virtual

◆ GetModulatorValueThreadSafe()

virtual bool IAudioModulationManager::GetModulatorValueThreadSafe ( const Audio::FModulatorHandle &  ModulatorHandle,
float &  OutValue 
) const
protectedpure virtual

◆ Initialize()

virtual void IAudioModulationManager::Initialize ( const FAudioPluginInitializationParams &  InitializationParams)
pure virtual

Initialize the modulation plugin with the same rate and number of sources

◆ OnAuditionEnd()

virtual void IAudioModulationManager::OnAuditionEnd ( )
pure virtual

◆ OnPostHelp()

virtual bool IAudioModulationManager::OnPostHelp ( FCommonViewportClient *  ViewportClient,
const TCHAR *  Stream 
)
pure virtual

Request to post help from active plugin (non-shipping builds only)

◆ OnRenderStat()

virtual int32 IAudioModulationManager::OnRenderStat ( FViewport *  Viewport,
FCanvas *  Canvas,
int32  X,
int32  Y,
const UFont &  Font,
const FVector *  ViewLocation,
const FRotator *  ViewRotation 
)
pure virtual

Render stats pertaining to modulation (non-shipping builds only)

◆ OnToggleStat()

virtual bool IAudioModulationManager::OnToggleStat ( FCommonViewportClient *  ViewportClient,
const TCHAR *  Stream 
)
pure virtual

Toggle showing render stats pertaining to modulation (non-shipping builds only)

◆ ProcessModulators()

virtual void IAudioModulationManager::ProcessModulators ( const double  InElapsed)
pure virtual

UE_BUILD_SHIPPING.

Processes all modulators Run on the audio render thread prior to processing audio

◆ RegisterModulator()

virtual void IAudioModulationManager::RegisterModulator ( uint32  InHandleId,
Audio::FModulatorId  InModulatorId 
)
protectedpure virtual

◆ UnregisterModulator()

virtual void IAudioModulationManager::UnregisterModulator ( const Audio::FModulatorHandle &  InHandle)
protectedpure virtual

◆ UpdateModulator()

virtual void IAudioModulationManager::UpdateModulator ( const USoundModulatorBase &  InModulator)
pure virtual

Updates modulator definition on the AudioRender Thread with that provided by the UObject representation

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