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

#include <ModulationMatrix.h>

Classes

struct  FDestData
 

Public Member Functions

SIGNALPROCESSING_API FModulationMatrix ()
 
virtual SIGNALPROCESSING_API ~FModulationMatrix ()
 
SIGNALPROCESSING_API void Init (const int32 NumVoices)
 
SIGNALPROCESSING_API int32 GetNumPatches (const int32 VoiceId) const
 
SIGNALPROCESSING_API FPatchSource CreatePatchSource (const int32 VoiceId)
 
SIGNALPROCESSING_API FPatchDestination CreatePatchDestination (const int32 VoiceId, const int32 Stage, const float DefaultDepth)
 
SIGNALPROCESSING_API bool AddPatch (const int32 VoiceId, FPatch *Patch)
 
SIGNALPROCESSING_API bool RemovePatch (const int32 VoiceId, FPatch *Patch)
 
SIGNALPROCESSING_API void ResetPatchSourceState ()
 
SIGNALPROCESSING_API void ClearPatches (const int32 VoiceId)
 
SIGNALPROCESSING_API bool SetSourceValue (const int32 VoiceId, const FPatchSource &Source, const float Value)
 
SIGNALPROCESSING_API bool GetDestinationValue (const int32 VoiceId, const FPatchDestination &Destination, float &OutValue) const
 
SIGNALPROCESSING_API void Update (const int32 VoiceId, const int32 Stage=INDEX_NONE)
 

Protected Member Functions

SIGNALPROCESSING_API void ResetDestinations (const int32 VoiceId)
 
SIGNALPROCESSING_API bool ValidatePatch (const int32 VoiceId, FPatch *Patch)
 

Protected Attributes

int32 NumVoices
 
TArray< TArray< FPatch * > > Patches
 
TArray< TArray< float > > Sources
 
TArray< TArray< FDestData > > Destinations
 

Constructor & Destructor Documentation

◆ FModulationMatrix()

Audio::FModulationMatrix::FModulationMatrix ( )

◆ ~FModulationMatrix()

Audio::FModulationMatrix::~FModulationMatrix ( )
virtual

Member Function Documentation

◆ AddPatch()

bool Audio::FModulationMatrix::AddPatch ( const int32  VoiceId,
FPatch Patch 
)

◆ ClearPatches()

void Audio::FModulationMatrix::ClearPatches ( const int32  VoiceId)

◆ CreatePatchDestination()

FPatchDestination Audio::FModulationMatrix::CreatePatchDestination ( const int32  VoiceId,
const int32  Stage,
const float  DefaultDepth 
)

◆ CreatePatchSource()

FPatchSource Audio::FModulationMatrix::CreatePatchSource ( const int32  VoiceId)

◆ GetDestinationValue()

bool Audio::FModulationMatrix::GetDestinationValue ( const int32  VoiceId,
const FPatchDestination Destination,
float OutValue 
) const

◆ GetNumPatches()

int32 Audio::FModulationMatrix::GetNumPatches ( const int32  VoiceId) const

◆ Init()

void Audio::FModulationMatrix::Init ( const int32  NumVoices)

◆ RemovePatch()

bool Audio::FModulationMatrix::RemovePatch ( const int32  VoiceId,
FPatch Patch 
)

◆ ResetDestinations()

void Audio::FModulationMatrix::ResetDestinations ( const int32  VoiceId)
protected

◆ ResetPatchSourceState()

void Audio::FModulationMatrix::ResetPatchSourceState ( )

◆ SetSourceValue()

bool Audio::FModulationMatrix::SetSourceValue ( const int32  VoiceId,
const FPatchSource Source,
const float  Value 
)

◆ Update()

void Audio::FModulationMatrix::Update ( const int32  VoiceId,
const int32  Stage = INDEX_NONE 
)

◆ ValidatePatch()

bool Audio::FModulationMatrix::ValidatePatch ( const int32  VoiceId,
FPatch Patch 
)
protected

Member Data Documentation

◆ Destinations

TArray<TArray<FDestData> > Audio::FModulationMatrix::Destinations
protected

◆ NumVoices

int32 Audio::FModulationMatrix::NumVoices
protected

◆ Patches

TArray<TArray<FPatch*> > Audio::FModulationMatrix::Patches
protected

◆ Sources

TArray<TArray<float> > Audio::FModulationMatrix::Sources
protected

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