FST_FFTThread Class Reference

FFT processing thread class that runs audio analysis in a background thread. More...

#include <ST_FFTThread.h>

Public Member Functions
	FST_FFTThread (FString InName, FFFTIOData InFFTIOData, TObjectPtr< UFFTConfig > InFFTConfig, class UST_AudioIOBase *InAnalyserBase)
	Constructor.
	~FST_FFTThread ()
	Destructor.
virtual bool	CreateThread (bool bStartPaused)
	Use this method to create the thread!
virtual void	PauseThread ()
	Pause the thread.
virtual void	ContinueThread ()
	Continue/unpause the thread.
virtual void	Main ()
	The main processing method.
virtual void	ExTrigger ()
	Wake the FFT worker thread if it is waiting.
virtual bool	IsThreadPaused () const
	Check if the thread is currently paused.
virtual void	EnsureCompletion ()
	Use this method to kill the thread! Safely ensures thread completion.

Protected Member Functions
virtual bool	Init () override
	Initialize the thread. Called once before Run().
virtual uint32	Run () override
	Main loop where work is performed.
virtual void	Stop () override
	Request the thread to stop.
virtual void	Exit () override
	Clean up after thread has stopped.

Detailed Description

FFT processing thread class that runs audio analysis in a background thread.

Constructor & Destructor Documentation

FST_FFTThread()

FST_FFTThread::FST_FFTThread	(	FString	InName,
		FFFTIOData	InFFTIOData,
		TObjectPtr< UFFTConfig >	InFFTConfig,
		class UST_AudioIOBase *	InAnalyserBase )

Constructor.

Parameters

InName	Name of the thread.
InFFTIOData	Input/Output data structure for FFT processing.
InFFTConfig	Configuration settings for FFT.
InAnalyserBase	Pointer to the audio analyser base object.

Member Function Documentation

CreateThread()

bool FST_FFTThread::CreateThread ( bool bStartPaused )

virtual

Use this method to create the thread!

Parameters

bStartPaused

Whether to start the thread in a paused state.

Returns

True if the thread was successfully created.

IsThreadPaused()

bool FST_FFTThread::IsThreadPaused ( ) const

inlinevirtual

Check if the thread is currently paused.

Returns

True if the thread is paused.

---

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

• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioProcessing/Public/FFT/ST_FFTThread.h
• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioProcessing/Private/FFT/ST_FFTThread.cpp