UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::FSpectrumBandExtractor Class Reference
+ Inheritance diagram for Audio::FSpectrumBandExtractor:

Public Member Functions

 FSpectrumBandExtractor (const FSpectrumBandExtractorSettings &InSettings)
 
virtual void SetSettings (const FSpectrumBandExtractorSettings &InSettings) override
 
virtual void SetSpectrumSettings (const FSpectrumBandExtractorSpectrumSettings &InSpectrumSettings) override
 
virtual void RemoveAllBands () override
 
virtual int32 GetNumBands () const override
 
virtual void AddBand (const FBandSettings &InBandSettings) override
 
virtual void ExtractBands (const FAlignedFloatBuffer &InComplexBuffer, double InTimestamp, TArray< float > &OutValues) override
 
- Public Member Functions inherited from Audio::ISpectrumBandExtractor
virtual ~ISpectrumBandExtractor ()
 

Additional Inherited Members

- Public Types inherited from Audio::ISpectrumBandExtractor
enum class  EBandType : uint8 { NearestNeighbor , Lerp , Quadratic , ConstantQ }
 
- Static Public Member Functions inherited from Audio::ISpectrumBandExtractor
static SIGNALPROCESSING_API TUniquePtr< ISpectrumBandExtractorCreateSpectrumBandExtractor (const FSpectrumBandExtractorSettings &InSettings)
 

Constructor & Destructor Documentation

◆ FSpectrumBandExtractor()

Audio::FSpectrumBandExtractor::FSpectrumBandExtractor ( const FSpectrumBandExtractorSettings InSettings)
inline

Member Function Documentation

◆ AddBand()

virtual void Audio::FSpectrumBandExtractor::AddBand ( const FBandSettings InSettings)
inlineoverridevirtual

Adds a band to extract based on the given settings.

Implements Audio::ISpectrumBandExtractor.

◆ ExtractBands()

virtual void Audio::FSpectrumBandExtractor::ExtractBands ( const FAlignedFloatBuffer InComplexBuffer,
double  InTimestamp,
TArray< float > &  OutValues 
)
inlineoverridevirtual

Extract the bands from a complex frequency buffer.

Parameters
InComplexBuffer- Buffer of complex frequency data from a FFT.
InTimestamp- A timestamp associated with the input complex buffer.
OutValues- Array to store output bands.

Implements Audio::ISpectrumBandExtractor.

◆ GetNumBands()

virtual int32 Audio::FSpectrumBandExtractor::GetNumBands ( ) const
inlineoverridevirtual

Returns the total number of bands.

Implements Audio::ISpectrumBandExtractor.

◆ RemoveAllBands()

virtual void Audio::FSpectrumBandExtractor::RemoveAllBands ( )
inlineoverridevirtual

Removes all added bands.

Implements Audio::ISpectrumBandExtractor.

◆ SetSettings()

virtual void Audio::FSpectrumBandExtractor::SetSettings ( const FSpectrumBandExtractorSettings InSettings)
inlineoverridevirtual

Sets and updates the settings for the band extractor

Implements Audio::ISpectrumBandExtractor.

◆ SetSpectrumSettings()

virtual void Audio::FSpectrumBandExtractor::SetSpectrumSettings ( const FSpectrumBandExtractorSpectrumSettings InSettings)
inlineoverridevirtual

Set the settings and update cached internal values if needed

Implements Audio::ISpectrumBandExtractor.


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