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

#include <SpectrumAnalyzer.h>

Public Member Functions

SIGNALPROCESSING_API FAsyncSpectrumAnalyzer ()
 
SIGNALPROCESSING_API FAsyncSpectrumAnalyzer (float InSampleRate)
 
SIGNALPROCESSING_API FAsyncSpectrumAnalyzer (const FSpectrumAnalyzerSettings &InSettings, float InSampleRate)
 
virtual SIGNALPROCESSING_API ~FAsyncSpectrumAnalyzer ()
 
SIGNALPROCESSING_API void Init (float InSampleRate)
 
SIGNALPROCESSING_API void Init (const FSpectrumAnalyzerSettings &InSettings, float InSampleRate)
 
SIGNALPROCESSING_API bool IsInitialized ()
 
SIGNALPROCESSING_API void SetSettings (const FSpectrumAnalyzerSettings &InSettings)
 
SIGNALPROCESSING_API void GetSettings (FSpectrumAnalyzerSettings &OutSettings)
 
SIGNALPROCESSING_API float GetMagnitudeForFrequency (float InFrequency, FSpectrumAnalyzer::EPeakInterpolationMethod InMethod=FSpectrumAnalyzer::EPeakInterpolationMethod::Linear)
 
SIGNALPROCESSING_API float GetNormalizedMagnitudeForFrequency (float InFrequency, FSpectrumAnalyzer::EPeakInterpolationMethod InMethod=FSpectrumAnalyzer::EPeakInterpolationMethod::Linear)
 
SIGNALPROCESSING_API float GetPhaseForFrequency (float InFrequency, FSpectrumAnalyzer::EPeakInterpolationMethod InMethod=FSpectrumAnalyzer::EPeakInterpolationMethod::Linear)
 
SIGNALPROCESSING_API void GetBands (ISpectrumBandExtractor &InExtractor, TArray< float > &OutValues)
 
SIGNALPROCESSING_API void LockOutputBuffer ()
 
SIGNALPROCESSING_API void UnlockOutputBuffer ()
 
SIGNALPROCESSING_API bool PushAudio (const TSampleBuffer< float > &InBuffer)
 
SIGNALPROCESSING_API bool PushAudio (const float *InBuffer, int32 NumSamples)
 
SIGNALPROCESSING_API bool PerformAnalysisIfPossible (bool bUseLatestAudio=false)
 
SIGNALPROCESSING_API bool PerformAsyncAnalysisIfPossible (bool bUseLatestAudio=false)
 

Constructor & Destructor Documentation

◆ FAsyncSpectrumAnalyzer() [1/3]

Audio::FAsyncSpectrumAnalyzer::FAsyncSpectrumAnalyzer ( )

◆ FAsyncSpectrumAnalyzer() [2/3]

Audio::FAsyncSpectrumAnalyzer::FAsyncSpectrumAnalyzer ( float  InSampleRate)

◆ FAsyncSpectrumAnalyzer() [3/3]

Audio::FAsyncSpectrumAnalyzer::FAsyncSpectrumAnalyzer ( const FSpectrumAnalyzerSettings InSettings,
float  InSampleRate 
)

◆ ~FAsyncSpectrumAnalyzer()

Audio::FAsyncSpectrumAnalyzer::~FAsyncSpectrumAnalyzer ( )
virtual

Member Function Documentation

◆ GetBands()

void Audio::FAsyncSpectrumAnalyzer::GetBands ( ISpectrumBandExtractor InExtractor,
TArray< float > &  OutValues 
)

◆ GetMagnitudeForFrequency()

float Audio::FAsyncSpectrumAnalyzer::GetMagnitudeForFrequency ( float  InFrequency,
FSpectrumAnalyzer::EPeakInterpolationMethod  InMethod = FSpectrumAnalyzer::EPeakInterpolationMethod::Linear 
)

◆ GetNormalizedMagnitudeForFrequency()

float Audio::FAsyncSpectrumAnalyzer::GetNormalizedMagnitudeForFrequency ( float  InFrequency,
FSpectrumAnalyzer::EPeakInterpolationMethod  InMethod = FSpectrumAnalyzer::EPeakInterpolationMethod::Linear 
)

◆ GetPhaseForFrequency()

float Audio::FAsyncSpectrumAnalyzer::GetPhaseForFrequency ( float  InFrequency,
FSpectrumAnalyzer::EPeakInterpolationMethod  InMethod = FSpectrumAnalyzer::EPeakInterpolationMethod::Linear 
)

◆ GetSettings()

void Audio::FAsyncSpectrumAnalyzer::GetSettings ( FSpectrumAnalyzerSettings OutSettings)

◆ Init() [1/2]

void Audio::FAsyncSpectrumAnalyzer::Init ( const FSpectrumAnalyzerSettings InSettings,
float  InSampleRate 
)

◆ Init() [2/2]

void Audio::FAsyncSpectrumAnalyzer::Init ( float  InSampleRate)

◆ IsInitialized()

bool Audio::FAsyncSpectrumAnalyzer::IsInitialized ( )

◆ LockOutputBuffer()

void Audio::FAsyncSpectrumAnalyzer::LockOutputBuffer ( )

◆ PerformAnalysisIfPossible()

bool Audio::FAsyncSpectrumAnalyzer::PerformAnalysisIfPossible ( bool  bUseLatestAudio = false)

◆ PerformAsyncAnalysisIfPossible()

bool Audio::FAsyncSpectrumAnalyzer::PerformAsyncAnalysisIfPossible ( bool  bUseLatestAudio = false)

◆ PushAudio() [1/2]

bool Audio::FAsyncSpectrumAnalyzer::PushAudio ( const float InBuffer,
int32  NumSamples 
)

◆ PushAudio() [2/2]

bool Audio::FAsyncSpectrumAnalyzer::PushAudio ( const TSampleBuffer< float > &  InBuffer)

◆ SetSettings()

void Audio::FAsyncSpectrumAnalyzer::SetSettings ( const FSpectrumAnalyzerSettings InSettings)

◆ UnlockOutputBuffer()

void Audio::FAsyncSpectrumAnalyzer::UnlockOutputBuffer ( )

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