AST_N_VisAmplitude Class Reference

AST_N_VisAmplitude is a derived class from AST_VisNiagaraBase that handles visualization of amplitude data. It manages the set of registered audio I/O instances and provides methods for setting parameters and handling amplitude and audio I/O status changes. More...

#include <ST_N_VisAmplitude.h>

Protected Member Functions
virtual bool	SetConstantParameters () override
virtual void	OnAmplitudesReady_Implementation (const TArray< float > &Amplitudes, FIntPoint IOId) override
virtual void	OnAudioIOStatusChanged_Implementation (bool bIsActive, FIntPoint IOId) override
Protected Member Functions inherited from AST_VisBase
virtual void	PostInitializeComponents () override

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	BeginPlay () 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)
virtual bool	SetDynamicParameters ()
Public Member Functions inherited from IST_AudioProcessingInterface
void	OnAudioIOStatusChanged (bool bIsActive, FIntPoint IOId)
	Event triggered when the status of an audio I/O device changes.
void	OnRawMagnitudesReady (const TArray< float > &RawMagnitudes, FIntPoint IOId)
	Event triggered when raw magnitude data is ready for an audio I/O device.
void	OnFrequencyBandsReady (const TArray< float > &FrequencyBands, int32 NumFrequencyBands, FIntPoint IOId)
	Event triggered when frequency band data is ready for an audio I/O device.
void	OnAmplitudesReady (const TArray< float > &Amplitudes, FIntPoint IOId)
	Event triggered when amplitude data is ready for an audio I/O device.
void	OnPitchesReady (const TArray< float > &Pitches, 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, FIntPoint IOId)
	Event triggered when a beat is detected in the audio data for an I/O device.
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

Detailed Description

AST_N_VisAmplitude is a derived class from AST_VisNiagaraBase that handles visualization of amplitude data. It manages the set of registered audio I/O instances and provides methods for setting parameters and handling amplitude and audio I/O status changes.

Member Function Documentation

OnAmplitudesReady_Implementation()

void AST_N_VisAmplitude::OnAmplitudesReady_Implementation ( const TArray< float > & Amplitudes, FIntPoint IOId )

overrideprotectedvirtual

Called when amplitudes are ready for processing.

Parameters

Amplitudes	An array of amplitude values.
IOId	The identifier of the I/O operation associated with the amplitudes.

OnAudioIOStatusChanged_Implementation()

void AST_N_VisAmplitude::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.

SetConstantParameters()

bool AST_N_VisAmplitude::SetConstantParameters ( )

overrideprotectedvirtual

Sets the constant parameters for the visualization.

Returns

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

Reimplemented from AST_VisBase.

---

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

• C:/Users/aaron/UE5/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Public/Niagara/Vis/ST_N_VisAmplitude.h
• C:/Users/aaron/UE5/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Private/Niagara/Vis/ST_N_VisAmplitude.cpp