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

#include <Amp.h>

Public Member Functions

SIGNALPROCESSING_API FAmp ()
 
SIGNALPROCESSING_API ~FAmp ()
 
SIGNALPROCESSING_API void Init (const int32 InVoiceId=INDEX_NONE, FModulationMatrix *ModMatrix=nullptr)
 
SIGNALPROCESSING_API void SetGainDb (const float InGainDB)
 
SIGNALPROCESSING_API void SetGainModDb (const float InGainModDb)
 
SIGNALPROCESSING_API void SetGain (const float InGainLinear)
 
SIGNALPROCESSING_API void SetGainMod (const float InBipolarGainModLinear)
 
SIGNALPROCESSING_API void SetGainEnv (const float InGainEnv)
 
SIGNALPROCESSING_API void SetGainEnvDb (const float InGainEnvDb)
 
SIGNALPROCESSING_API void SetGainRange (const float InMin, const float InMax)
 
SIGNALPROCESSING_API void SetVelocity (const float InVelocity)
 
SIGNALPROCESSING_API void SetPan (const float InPan)
 
SIGNALPROCESSING_API void SetPanModulator (const float InPanMod)
 
SIGNALPROCESSING_API void ProcessAudio (const float LeftIn, float *LeftOutput, float *RightOutput)
 
SIGNALPROCESSING_API void ProcessAudio (const float LeftIn, const float RightIn, float *LeftOutput, float *RightOutput)
 
SIGNALPROCESSING_API void Generate (float &OutGainLeft, float &OutGainRight)
 
SIGNALPROCESSING_API void Reset ()
 
SIGNALPROCESSING_API void Update ()
 
const FPatchDestination GetModDestGainScale () const
 
const FPatchDestination GetModDestGainEnv () const
 
const FPatchDestination GetModDestPan () const
 

Protected Attributes

int32 VoiceId
 
float LeftGain
 
float RightGain
 
float TargetLeftGain
 
float TargetRightGain
 
int32 TargetDeltaSamples
 
int32 CurrentLerpSample
 
float TargetLeftSlope
 
float TargetRightSlope
 
float GainMin
 
float GainMax
 
float GainControl
 
float GainVelocity
 
float GainMod
 
float GainEnv
 
float Pan
 
float PanMod
 
FModulationMatrixModMatrix
 
FPatchDestination GainScaleDest
 
FPatchDestination GainEnvDest
 
FPatchDestination GainPanDest
 
bool bChanged
 

Constructor & Destructor Documentation

◆ FAmp()

Audio::FAmp::FAmp ( )

◆ ~FAmp()

Audio::FAmp::~FAmp ( )

Member Function Documentation

◆ Generate()

void Audio::FAmp::Generate ( float OutGainLeft,
float OutGainRight 
)

◆ GetModDestGainEnv()

const FPatchDestination Audio::FAmp::GetModDestGainEnv ( ) const
inline

◆ GetModDestGainScale()

const FPatchDestination Audio::FAmp::GetModDestGainScale ( ) const
inline

◆ GetModDestPan()

const FPatchDestination Audio::FAmp::GetModDestPan ( ) const
inline

◆ Init()

void Audio::FAmp::Init ( const int32  InVoiceId = INDEX_NONE,
FModulationMatrix ModMatrix = nullptr 
)

◆ ProcessAudio() [1/2]

void Audio::FAmp::ProcessAudio ( const float  LeftIn,
const float  RightIn,
float LeftOutput,
float RightOutput 
)

◆ ProcessAudio() [2/2]

void Audio::FAmp::ProcessAudio ( const float  LeftIn,
float LeftOutput,
float RightOutput 
)

◆ Reset()

void Audio::FAmp::Reset ( )

◆ SetGain()

void Audio::FAmp::SetGain ( const float  InGainLinear)

◆ SetGainDb()

void Audio::FAmp::SetGainDb ( const float  InGainDB)

◆ SetGainEnv()

void Audio::FAmp::SetGainEnv ( const float  InGainEnv)

◆ SetGainEnvDb()

void Audio::FAmp::SetGainEnvDb ( const float  InGainEnvDb)

◆ SetGainMod()

void Audio::FAmp::SetGainMod ( const float  InBipolarGainModLinear)

◆ SetGainModDb()

void Audio::FAmp::SetGainModDb ( const float  InGainModDb)

◆ SetGainRange()

void Audio::FAmp::SetGainRange ( const float  InMin,
const float  InMax 
)

◆ SetPan()

void Audio::FAmp::SetPan ( const float  InPan)

◆ SetPanModulator()

void Audio::FAmp::SetPanModulator ( const float  InPanMod)

◆ SetVelocity()

void Audio::FAmp::SetVelocity ( const float  InVelocity)

◆ Update()

void Audio::FAmp::Update ( )

Member Data Documentation

◆ bChanged

bool Audio::FAmp::bChanged
protected

◆ CurrentLerpSample

int32 Audio::FAmp::CurrentLerpSample
protected

◆ GainControl

float Audio::FAmp::GainControl
protected

◆ GainEnv

float Audio::FAmp::GainEnv
protected

◆ GainEnvDest

FPatchDestination Audio::FAmp::GainEnvDest
protected

◆ GainMax

float Audio::FAmp::GainMax
protected

◆ GainMin

float Audio::FAmp::GainMin
protected

◆ GainMod

float Audio::FAmp::GainMod
protected

◆ GainPanDest

FPatchDestination Audio::FAmp::GainPanDest
protected

◆ GainScaleDest

FPatchDestination Audio::FAmp::GainScaleDest
protected

◆ GainVelocity

float Audio::FAmp::GainVelocity
protected

◆ LeftGain

float Audio::FAmp::LeftGain
protected

◆ ModMatrix

FModulationMatrix* Audio::FAmp::ModMatrix
protected

◆ Pan

float Audio::FAmp::Pan
protected

◆ PanMod

float Audio::FAmp::PanMod
protected

◆ RightGain

float Audio::FAmp::RightGain
protected

◆ TargetDeltaSamples

int32 Audio::FAmp::TargetDeltaSamples
protected

◆ TargetLeftGain

float Audio::FAmp::TargetLeftGain
protected

◆ TargetLeftSlope

float Audio::FAmp::TargetLeftSlope
protected

◆ TargetRightGain

float Audio::FAmp::TargetRightGain
protected

◆ TargetRightSlope

float Audio::FAmp::TargetRightSlope
protected

◆ VoiceId

int32 Audio::FAmp::VoiceId
protected

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