Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > SignalProcessing > DSP > FAsyncSpectrumAnalyzer

Light Theme

Dark Theme

FAsyncSpectrumAnalyzer

SpectrumAnalyzer for computing spectrum in async task.

Windows

MacOS

Linux

References

Module	SignalProcessing
Header	/Engine/Source/Runtime/SignalProcessing/Public/DSP/SpectrumAnalyzer.h
Include	#include "DSP/SpectrumAnalyzer.h"

Syntax

class FAsyncSpectrumAnalyzer

Remarks

SpectrumAnalyzer for computing spectrum in async task.

Constructors

	Name	Description
	FAsyncSpectrumAnalyzer()
	FAsyncSpectrumAnalyzer ( float InSampleRate )	If an instance is created using either of these constructors, Init() is not neccessary.
	FAsyncSpectrumAnalyzer ( const FSpectrumAnalyzerSettings& I..., float InSampleRate )

Destructors

	Name	Description
	~FAsyncSpectrumAnalyzer()

Functions

	Name	Description
void	GetBands ( ISpectrumBandExtractor& InExtracto..., TArray< float >& OutValues )	Return array of bands using spectrum band extractor.
float	GetMagnitudeForFrequency ( float InFrequency, FSpectrumAnalyzer::EPeakInterpolati... )	Samples magnitude (linearly) for a given frequency, in Hz.
float	GetNormalizedMagnitudeForFrequency ( float InFrequency, FSpectrumAnalyzer::EPeakInterpolati... )
float	GetPhaseForFrequency ( float InFrequency, FSpectrumAnalyzer::EPeakInterpolati... )	Samples phase for a given frequency, in Hz.
void	GetSettings ( FSpectrumAnalyzerSettings& OutSett... )	Get the current settings used by this Spectrum Analyzer.
void	Init ( const FSpectrumAnalyzerSettings& I..., float InSampleRate )	Initialize sample rate of analyzer if not known at time of construction.
void	Init ( float InSampleRate )	Initialize sample rate of analyzer if not known at time of construction.
bool	IsInitialized()	Returns false if this instance of FSpectrumAnalyzer was constructed with the default constructor and Init() has not been called yet.
void	LockOutputBuffer()	You can call this function to ensure that you're sampling the same window of frequency data, Then call UnlockOutputBuffer when you're done.
bool	PerformAnalysisIfPossible ( bool bUseLatestAudio )	Thread safe call to perform actual FFT.
bool	PerformAsyncAnalysisIfPossible ( bool bUseLatestAudio )	Thread safe call to perform actual FFT.
bool	PushAudio ( const TSampleBuffer< float >& InBu... )	Push audio to queue. Returns false if the queue is already full.
bool	PushAudio ( const float* InBuffer, int32 NumSamples )	Push audio to queue. Returns false if the queue is already full.
void	SetSettings ( const FSpectrumAnalyzerSettings& I... )	Update the settings used by this Spectrum Analyzer. Safe to call on any thread, but should not be called every tick.
void	UnlockOutputBuffer()

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

Take our survey

Dismiss