AST_N_VisFrequencyBuffer Class Reference

AST_N_VisFrequencyBuffer is a derived class from AST_VisNiagaraBase. It is responsible for handling frequency buffer data in the context of audio visualization. The class sets constant and dynamic parameters, manages audio I/O status changes, and processes frequency bands. More...

#include <ST_N_VisFrequencyBuffer.h>

Protected Member Functions
virtual void	BeginPlay () override
virtual bool	SetConstantParameters () override
virtual bool	SetDynamicParameters () override
virtual void	OnAudioIOStatusChanged_Implementation (bool bIsActive, FIntPoint IOId) override
virtual void	OnFrequencyBandsReady_Implementation (const TArray< float > &FrequencyBands, int32 NumFrequencyBands, FIntPoint IOId) override
Protected Member Functions inherited from AST_VisBase
virtual void	PostInitializeComponents () override

Protected Attributes
FST_AudioIOData_GameThread	ST_AudioIOData_GT
Protected Attributes inherited from AST_VisNiagaraBase
int32	Channel = 0
class UNiagaraComponent *	Niagara = nullptr
Protected Attributes inherited from AST_VisBase
USceneComponent *	Root = nullptr
bool	bCustomBeginPlay = false
bool	bSamplerActivates = false
bool	bZeroSamplersDeactivates = false
int32	Default_AudioIOs = 0
int32	Registered_AudioIOs = 0

Additional Inherited Members
Public Member Functions inherited from AST_VisNiagaraBase
	AST_VisNiagaraBase ()
virtual void	HandleBeginPlay () override
void	SetNiagaraSystem (class UNiagaraSystem *System)
Public Member Functions inherited from AST_VisBase
	AST_VisBase ()
virtual void	Tick (float DeltaTime) override
virtual void	EndPlay (const EEndPlayReason::Type EndPlayReason) override
virtual bool	RegisterToIO (EAudioIOType NewAudioIOType)
bool	RegisterToIO (int32 NewAudioIOType)
virtual void	DeregisterFromIO (EAudioIOType CurrAudioIOType)
void	DeregisterFromIO (int32 CurrAudioIOType)
Public Member Functions inherited from IST_AudioProcessingInterface
void	OnAudioIOStatusChanged (const bool bIsActive, const FIntPoint IOId)
	Event triggered when the status of an audio I/O device changes.
void	OnRawMagnitudesReady (const TArray< float > &RawMagnitudes, const FIntPoint IOId)
	Event triggered when raw magnitude data is ready for an audio I/O device.
void	OnFrequencyBandsReady (const TArray< float > &FrequencyBands, const int32 NumFrequencyBands, const FIntPoint IOId)
	Event triggered when frequency band data is ready for an audio I/O device.
void	OnAmplitudesReady (const TArray< float > &Amplitudes, const FIntPoint IOId)
	Event triggered when amplitude data is ready for an audio I/O device.
void	OnPitchesReady (const TArray< float > &Pitches, const FIntPoint IOId)
	Event triggered when pitch data is ready for an audio I/O device.
void	OnBeatDetected (const TArray< float > &Beats, const TArray< FChannelBeatDetection > &BeatDetectionForChannel, const FIntPoint IOId)
	Event triggered when a beat is detected in the audio data for an I/O device.

Detailed Description

AST_N_VisFrequencyBuffer is a derived class from AST_VisNiagaraBase. It is responsible for handling frequency buffer data in the context of audio visualization. The class sets constant and dynamic parameters, manages audio I/O status changes, and processes frequency bands.

Member Function Documentation

BeginPlay()

void AST_N_VisFrequencyBuffer::BeginPlay ( )

overrideprotectedvirtual

Called when the game begins or when the actor is spawned. This function is used to initialize any necessary components or perform setup operations.

Reimplemented from AST_VisBase.

OnAudioIOStatusChanged_Implementation()

void AST_N_VisFrequencyBuffer::OnAudioIOStatusChanged_Implementation ( bool bIsActive, FIntPoint IOId )

overrideprotectedvirtual

Called when the audio I/O status changes.

Parameters

bIsActive	Indicates if the audio I/O is active.
IOId	The identifier of the I/O operation whose status has changed.

OnFrequencyBandsReady_Implementation()

void AST_N_VisFrequencyBuffer::OnFrequencyBandsReady_Implementation ( const TArray< float > & FrequencyBands, int32 NumFrequencyBands, FIntPoint IOId )

overrideprotectedvirtual

Called when the frequency bands are ready to be processed.

Parameters

FrequencyBands	The array of frequency band data.
NumFrequencyBands	The number of frequency bands.
IOId	The identifier of the I/O operation associated with the frequency data.

SetConstantParameters()

bool AST_N_VisFrequencyBuffer::SetConstantParameters ( )

overrideprotectedvirtual

Sets the constant parameters for the frequency buffer visualization.

Returns

Returns true if the parameters were successfully set, false otherwise.

Reimplemented from AST_VisBase.

SetDynamicParameters()

bool AST_N_VisFrequencyBuffer::SetDynamicParameters ( )

overrideprotectedvirtual

Sets the dynamic parameters for the frequency buffer visualization.

Returns

Returns true if the parameters were successfully set, false otherwise.

Reimplemented from AST_VisBase.

Member Data Documentation

ST_AudioIOData_GT

FST_AudioIOData_GameThread AST_N_VisFrequencyBuffer::ST_AudioIOData_GT

protected

Structure holding audio I/O data for use in the game thread.

---

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

• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Public/Niagara/Vis/ST_N_VisFrequencyBuffer.h
• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Private/Niagara/Vis/ST_N_VisFrequencyBuffer.cpp