This actor is responsible for handling audio data and applying it to material parameters for visual effects. More...

#include <ST_M_VisMPC.h>

Protected Member Functions
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

virtual void	OnAmplitudesReady_Implementation (const TArray< float > &Amplitudes, FIntPoint IOId) override

virtual void	OnPitchesReady_Implementation (const TArray< float > &Pitches, FIntPoint IOId) override

virtual void	OnBeatDetected_Implementation (const TArray< float > &Beats, const TArray< FChannelBeatDetection > &BeatDetectionForChannel, FIntPoint IOId) override

Protected Member Functions inherited from AST_VisBase
virtual void	PostInitializeComponents () override

Protected Attributes
float	ReactiveTime = 0.0f

float	Amplitude = 0.0f

float	Pitch = 0.0f

TArray< FChannelBeatDetection >	CurrBeatDetectionForChannel

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_VisBase
	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)

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.

Detailed Description

This actor is responsible for handling audio data and applying it to material parameters for visual effects.

Member Function Documentation

◆ OnAmplitudesReady_Implementation()

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

overrideprotectedvirtual

Implementation of amplitudes ready event handling. This method is called when the amplitudes data is ready.

Parameters

Amplitudes	The array of amplitude values.
IOId	The identifier of the I/O.

◆ OnAudioIOStatusChanged_Implementation()

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

overrideprotectedvirtual

Implementation of audio I/O status change handling. This method is called when the audio I/O status changes.

Parameters

bIsActive	Flag indicating whether the I/O is active.
IOId	The identifier of the I/O.

◆ OnBeatDetected_Implementation()

void AST_M_VisMPC::OnBeatDetected_Implementation	(	const TArray< float > &	Beats,
		const TArray< FChannelBeatDetection > &	BeatDetectionForChannel,
		FIntPoint	IOId )

overrideprotectedvirtual

Called when beats are detected.

Parameters

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

◆ OnFrequencyBandsReady_Implementation()

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

overrideprotectedvirtual

Implementation of frequency bands ready event handling. This method is called when the frequency bands data is ready.

Parameters

FrequencyBands	The array of frequency bands.
NumFrequencyBands	The number of frequency bands.
IOId	The identifier of the I/O.

◆ OnPitchesReady_Implementation()

void AST_M_VisMPC::OnPitchesReady_Implementation	(	const TArray< float > &	Pitches,
		FIntPoint	IOId )

overrideprotectedvirtual

Implementation of pitches ready event handling. This method is called when the pitches data is ready.

Parameters

Pitches	The array of pitch values.
IOId	The identifier of the I/O.

◆ SetConstantParameters()

bool AST_M_VisMPC::SetConstantParameters ( )

overrideprotectedvirtual

Sets constant parameters for the material. This method configures material parameters that do not change during runtime.

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

Reimplemented from AST_VisBase.

◆ SetDynamicParameters()

bool AST_M_VisMPC::SetDynamicParameters ( )

overrideprotectedvirtual

Sets dynamic parameters for the material. This method configures material parameters that may change during runtime.

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

Reimplemented from AST_VisBase.

Member Data Documentation

◆ Amplitude

float AST_M_VisMPC::Amplitude = 0.0f

protected

The amplitude value used for driving visual effects based on audio amplitude.

◆ CurrBeatDetectionForChannel

TArray<FChannelBeatDetection> AST_M_VisMPC::CurrBeatDetectionForChannel

protected

Locally smoothed BeatDetectionForChannel. An array of channels and if a beat was detected and the current BPM.

◆ Pitch

float AST_M_VisMPC::Pitch = 0.0f

protected

The pitch value used for driving visual effects based on audio pitch.

◆ ReactiveTime

float AST_M_VisMPC::ReactiveTime = 0.0f

protected

The reactive time for the visual effect, representing how quickly it responds to audio input.

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

C:/Users/aaron/UE5/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Public/Material/Vis/ST_M_VisMPC.h
C:/Users/aaron/UE5/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Private/Material/Vis/ST_M_VisMPC.cpp

	VJ Master 1.3 Real-time audio analysis and visualisation.

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ OnAmplitudesReady_Implementation()

◆ OnAudioIOStatusChanged_Implementation()

◆ OnBeatDetected_Implementation()

◆ OnFrequencyBandsReady_Implementation()

◆ OnPitchesReady_Implementation()

◆ SetConstantParameters()

◆ SetDynamicParameters()

Member Data Documentation

◆ Amplitude

◆ CurrBeatDetectionForChannel

◆ Pitch

◆ ReactiveTime