AST_VisBase Class Reference

Base class for visualisation actors, implementing the audio processing interface. This class provides functionality for handling audio input/output, initialization, and updates. More...

#include <ST_VisBase.h>

Public Member Functions
	AST_VisBase ()
virtual void	Tick (float DeltaTime) override
virtual void	BeginPlay () override
virtual void	HandleBeginPlay ()
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	SetConstantParameters ()
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 Member Functions
virtual void	PostInitializeComponents () override

Protected Attributes
USceneComponent *	Root = nullptr
bool	bCustomBeginPlay = false
bool	bSamplerActivates = false
bool	bZeroSamplersDeactivates = false
int32	Default_AudioIOs = 0
int32	Registered_AudioIOs = 0

Detailed Description

Base class for visualisation actors, implementing the audio processing interface. This class provides functionality for handling audio input/output, initialization, and updates.

Constructor & Destructor Documentation

AST_VisBase()

AST_VisBase::AST_VisBase

(

)

Default constructor for AST_VisBase.

Member Function Documentation

BeginPlay()

void AST_VisBase::BeginPlay ( )

overridevirtual

Called when the game starts or when spawned.

Reimplemented in AST_C_VisAudioReactiveBoids, AST_N_VisFrequencyBuffer, and AST_VisComputeBase.

DeregisterFromIO() [1/2]

void AST_VisBase::DeregisterFromIO ( EAudioIOType CurrAudioIOType )

inlinevirtual

Deregisters the actor from an audio input/output type.

DeregisterFromIO() [2/2]

void AST_VisBase::DeregisterFromIO

(

int32

CurrAudioIOType

)

Overloaded method to deregister the actor from an audio input/output type using an integer.

EndPlay()

void AST_VisBase::EndPlay ( const EEndPlayReason::Type EndPlayReason )

overridevirtual

Called when the actor is destroyed or the game ends.

Reimplemented in AST_M_VisMIDIControlled.

HandleBeginPlay()

void AST_VisBase::HandleBeginPlay ( )

virtual

Custom method called from the game state at the start of the game.

Reimplemented in AST_M_VisMIDIControlled, and AST_VisNiagaraBase.

PostInitializeComponents()

void AST_VisBase::PostInitializeComponents ( )

overrideprotectedvirtual

Called after components have been initialized.

RegisterToIO() [1/2]

bool AST_VisBase::RegisterToIO ( EAudioIOType NewAudioIOType )

inlinevirtual

Registers the actor to an audio input/output type.

RegisterToIO() [2/2]

bool AST_VisBase::RegisterToIO

(

int32

NewAudioIOType

)

Overloaded method to register the actor to an audio input/output type using an integer.

SetConstantParameters()

bool AST_VisBase::SetConstantParameters ( )

virtual

Sets constant parameters for the visualisation actor.

Reimplemented in AST_C_VisAudioReactiveBoids, AST_M_VisMIDIControlled, AST_M_VisMPC, AST_N_VisAmplitude, AST_N_VisBeatDetection, AST_N_VisFrequency, AST_N_VisFrequencyBuffer, and AST_N_VisPitch.

SetDynamicParameters()

bool AST_VisBase::SetDynamicParameters ( )

virtual

Sets dynamic parameters for the visualisation actor.

Reimplemented in AST_C_VisAudioReactiveBoids, AST_M_VisMIDIControlled, AST_M_VisMPC, and AST_N_VisFrequencyBuffer.

Tick()

void AST_VisBase::Tick ( float DeltaTime )

overridevirtual

Called every frame to update the actor.

Reimplemented in AST_VisComputeBase.

Member Data Documentation

bCustomBeginPlay

bool AST_VisBase::bCustomBeginPlay = false

protected

Flag to specify if custom begin play logic is enabled.

bSamplerActivates

bool AST_VisBase::bSamplerActivates = false

protected

Flag to specify if the sampler activates the visualisation.

bZeroSamplersDeactivates

bool AST_VisBase::bZeroSamplersDeactivates = false

protected

Flag to specify if zero samplers deactivate the visualisation.

Default_AudioIOs

int32 AST_VisBase::Default_AudioIOs = 0

protected

Default audio input/output types for the visualisation actor.

Registered_AudioIOs

int32 AST_VisBase::Registered_AudioIOs = 0

protected

Registered audio input/output types for the visualisation actor.

Root

USceneComponent* AST_VisBase::Root = nullptr

protected

Root scene component for the actor.

---

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

• C:/Users/aaron/UE5/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Public/Main/Base/ST_VisBase.h
• C:/Users/aaron/UE5/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Private/Main/Base/ST_VisBase.cpp