ISpectrumBandExtractor

Interface for spectrum band extractors.

Windows
MacOS
Linux

References

Module

SignalProcessing

Header

/Engine/Source/Runtime/SignalProcessing/Public/DSP/SpectrumAnalyzer.h

Include

#include "DSP/SpectrumAnalyzer.h"

Syntax

class ISpectrumBandExtractor

Remarks

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.

Destructors

Name Description

Public function Virtual

~ISpectrumBandExtractor()

Functions

Name Description

Public function

void

 

AddBand

(
    const FBandSettings& InSettings
)

Adds a band to extract based on the given settings.

Public function Static

TUniquePtr< ...

 

CreateSpectrumBandExtractor

(
    const FSpectrumBandExtractorSetting...
)

Creates a ISpectrumBandExtractor.

Public function

void

 

ExtractBands

(
    const AlignedFloatBuffer& InComple...,
    double InTimestamp,
    TArray< float >& OutValues
)

Extract the bands from a complex frequency buffer.

Public function Const

int32

 

GetNumBands()

Returns the total number of bands.

Public function

void

 

RemoveAllBands()

Removes all added bands.

Public function

void

 

SetSettings

(
    const FSpectrumBandExtractorSetting...
)

Sets and updates the settings for the band extractor

Public function

void

 

SetSpectrumSettings

(
    const FSpectrumBandExtractorSpectru...
)

Set the settings and update cached internal values if needed

Classes

Name

Description

Public struct

FBandSettings

Settings for a single band

Enums

Name

Description

Public enum

EBandType

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss