AST_N_VisBeatDetection is a derived class from AST_VisNiagaraBase that handles beat detection visualization. It processes the beats detected from audio input and provides methods for setting parameters and handling audio I/O status changes. It also includes functionality for ticking and tracking time between beats. More...

#include <ST_N_VisBeatDetection.h>

Protected Member Functions
virtual void	Tick (float DeltaTime) override
virtual bool	SetConstantParameters () override
virtual void	OnBeatDetected_Implementation (const TArray< float > &Beats, const TArray< bool > &BeatDetectedForChannel, FIntPoint IOId) override
virtual void	OnAudioIOStatusChanged_Implementation (bool bIsActive, FIntPoint IOId) override
Protected Member Functions inherited from AST_VisBase
virtual void	PostInitializeComponents () override

Protected Attributes
int32	BeatsPerMinute = 0
Protected Attributes inherited from AST_VisNiagaraBase
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	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< bool > &BeatDetectedForChannel, FIntPoint IOId)
	Event triggered when a beat is detected in the audio data for an I/O device.

Detailed Description

AST_N_VisBeatDetection is a derived class from AST_VisNiagaraBase that handles beat detection visualization. It processes the beats detected from audio input and provides methods for setting parameters and handling audio I/O status changes. It also includes functionality for ticking and tracking time between beats.

Member Function Documentation

◆ OnAudioIOStatusChanged_Implementation()

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

◆ OnBeatDetected_Implementation()

void AST_N_VisBeatDetection::OnBeatDetected_Implementation	(	const TArray< float > &	Beats,
		const TArray< bool > &	BeatDetectedForChannel,
		FIntPoint	IOId )

overrideprotectedvirtual

Called when beats are detected.

Parameters

Beats	An array of detected beat values.
BeatDetectedForChannel	An array of channels and if a beat was detected.
IOId	The identifier of the I/O operation associated with the beats.

◆ SetConstantParameters()

bool AST_N_VisBeatDetection::SetConstantParameters ( )

overrideprotectedvirtual

Sets the constant parameters for the beat detection visualization.

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

Reimplemented from AST_VisBase.

◆ Tick()

void AST_N_VisBeatDetection::Tick ( float DeltaTime )

overrideprotectedvirtual

Called every frame to update the beat detection and related parameters.

Parameters

DeltaTime The time that has passed since the last frame.

Reimplemented from AST_VisBase.

Member Data Documentation

◆ BeatsPerMinute

int32 AST_N_VisBeatDetection::BeatsPerMinute = 0

protected

Beats per minute (BPM) value for the beat detection.

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_VisBeatDetection.h
H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Private/Niagara/Vis/ST_N_VisBeatDetection.cpp

	VJ Master 1.0 Real-time audio analysis and visualisation.

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ OnAudioIOStatusChanged_Implementation()

◆ OnBeatDetected_Implementation()

◆ SetConstantParameters()

◆ Tick()

Member Data Documentation

◆ BeatsPerMinute