Navigation
API > API/Runtime > API/Runtime/SignalProcessing
Interface for spectrum band extractors.
The SpectrumBandExtractor allows for band information to be maintained across multiple calls to retrieve bands values. By maintaining band information across multiple calls, some intermediate values can be cached to speed up the operation.
| Name | ISpectrumBandExtractor |
| Type | class |
| Header File | /Engine/Source/Runtime/SignalProcessing/Public/DSP/SpectrumAnalyzer.h |
| Include Path | #include "DSP/SpectrumAnalyzer.h" |
Syntax
class ISpectrumBandExtractor
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISpectrumBandExtractor() |
DSP/SpectrumAnalyzer.h |
Structs
| Name | Remarks |
|---|---|
| FBandSettings | Settings for a single band |
Enums
Public
| Name | Remarks |
|---|---|
| EBandType |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddBand
(
const FBandSettings& InSettings |
Adds a band to extract based on the given settings. | DSP/SpectrumAnalyzer.h | |
void ExtractBands
(
const FAlignedFloatBuffer& InComplexBuffer, |
Extract the bands from a complex frequency buffer. | DSP/SpectrumAnalyzer.h | |
int32 GetNumBands() |
Returns the total number of bands. | DSP/SpectrumAnalyzer.h | |
void RemoveAllBands() |
Removes all added bands. | DSP/SpectrumAnalyzer.h | |
void SetSettings
(
const FSpectrumBandExtractorSettings& InSettings |
Sets and updates the settings for the band extractor | DSP/SpectrumAnalyzer.h | |
void SetSpectrumSettings
(
const FSpectrumBandExtractorSpectrumSettings& InSettings |
Set the settings and update cached internal values if needed | DSP/SpectrumAnalyzer.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TUniquePtr< ISpectrumBandExtractor > CreateSpectrumBandExtractor
(
const FSpectrumBandExtractorSettings& InSettings |
Creates a ISpectrumBandExtractor. | DSP/SpectrumAnalyzer.h |