UST_AudioVisFunctionLibrary Class Reference

A function library that provides static methods to interact with audio visualization systems. More...

#include <ST_AudioVisFunctionLibrary.h>

Static Public Member Functions
static void	SetSTAudioBuffers (UNiagaraComponent *NiagaraSystem, FName OverrideName, FST_AudioIOData_GameThread InST_AudioIOData_GT)
static void	SetSTAudioIODataSize (UNiagaraComponent *NiagaraSystem, FName OverrideName, uint32 InIODataSize)
static void	SetSTReactiveBoids (UNiagaraComponent *NiagaraSystem, FName OverrideName, int32 numBoids, TRefCountPtr< FRDGPooledBuffer > InBuffer)
static void	UpdateGlobalBuffer_OnAudioIOStatusChanged (bool bIsActive, FIntPoint IOId, uint32 AudioIOCount, FST_AudioIOData_GameThread &ST_AudioIOData_GT)
static void	UpdateGlobalBuffer_OnFrequencyBandsReady (const TArray< float > &FrequencyBands, int32 NumFrequencyBands, FIntPoint IOId, FST_AudioIOData_GameThread &ST_AudioIOData_GT)
static void	UpdateGlobalBuffer_OnAmplitudesReady (const TArray< float > &Amplitudes, FIntPoint IOId, FST_AudioIOData_GameThread &ST_AudioIOData_GT)
static void	UpdateGlobalBuffer_OnPitchesReady (const TArray< float > &Pitches, FIntPoint IOId, FST_AudioIOData_GameThread &ST_AudioIOData_GT)
static void	UpdateGlobalBuffer_OnBeatDetected (const TArray< float > &Beats, const TArray< bool > &BeatDetectedForChannel, FIntPoint IOId, FST_AudioIOData_GameThread &ST_AudioIOData_GT)
static void	UpdateGlobalBuffer_AudioIOActivated (FIntPoint IOId, uint32 AudioIOCount, FST_AudioIOData_GameThread &ST_AudioIOData_GT)
static void	UpdateGlobalBuffer_AudioIODeactivated (FIntPoint IOId, FST_AudioIOData_GameThread &ST_AudioIOData_GT)

Detailed Description

A function library that provides static methods to interact with audio visualization systems.

A function library that provides static methods to interact with audio visualization systems. These functions assist in setting and updating audio data buffers and other audio-related parameters.

Member Function Documentation

SetSTAudioBuffers()

void UST_AudioVisFunctionLibrary::SetSTAudioBuffers ( UNiagaraComponent * NiagaraSystem, FName OverrideName, FST_AudioIOData_GameThread InST_AudioIOData_GT )

static

Sets the ST Audio buffers on the given Niagara system with specified overrides and audio I/O data.

Parameters

NiagaraSystem	The Niagara component to which the buffers will be set.
OverrideName	The name of the override to apply.
InST_AudioIOData_GT	The audio I/O data to be applied on the game thread.

SetSTAudioIODataSize()

void UST_AudioVisFunctionLibrary::SetSTAudioIODataSize ( UNiagaraComponent * NiagaraSystem, FName OverrideName, uint32 InIODataSize )

static

Sets the ST Audio I/O data size for the given Niagara system and override name.

Parameters

NiagaraSystem	The Niagara component to which the I/O data size will be set.
OverrideName	The name of the override.
InIODataSize	The size of the audio I/O data to be applied.

SetSTReactiveBoids()

void UST_AudioVisFunctionLibrary::SetSTReactiveBoids ( UNiagaraComponent * NiagaraSystem, FName OverrideName, int32 numBoids, TRefCountPtr< FRDGPooledBuffer > InBuffer )

static

Sets the ST Reactive Boid data on the given Niagara system with a specified number of boids.

Parameters

NiagaraSystem	The Niagara component to which the boid data will be applied.
OverrideName	The name of the override.
numBoids	The number of boids to be set.
InBuffer	The buffer containing the boid data.

UpdateGlobalBuffer_AudioIOActivated()

void UST_AudioVisFunctionLibrary::UpdateGlobalBuffer_AudioIOActivated ( FIntPoint IOId, uint32 AudioIOCount, FST_AudioIOData_GameThread & ST_AudioIOData_GT )

static

Updates the global buffer when an audio I/O is activated.

Parameters

IOId	The identifier for the I/O.
AudioIOCount	The count of active audio I/O.
ST_AudioIOData_GT	The audio I/O data to be updated on the game thread.

UpdateGlobalBuffer_AudioIODeactivated()

void UST_AudioVisFunctionLibrary::UpdateGlobalBuffer_AudioIODeactivated ( FIntPoint IOId, FST_AudioIOData_GameThread & ST_AudioIOData_GT )

static

Updates the global buffer when an audio I/O is deactivated.

Parameters

IOId	The identifier for the I/O.
ST_AudioIOData_GT	The audio I/O data to be updated on the game thread.

UpdateGlobalBuffer_OnAmplitudesReady()

void UST_AudioVisFunctionLibrary::UpdateGlobalBuffer_OnAmplitudesReady ( const TArray< float > & Amplitudes, FIntPoint IOId, FST_AudioIOData_GameThread & ST_AudioIOData_GT )

static

Updates the global buffer when amplitude data is ready.

Parameters

Amplitudes	The array of amplitude values.
IOId	The identifier for the I/O.
ST_AudioIOData_GT	The audio I/O data to be updated on the game thread.

UpdateGlobalBuffer_OnAudioIOStatusChanged()

void UST_AudioVisFunctionLibrary::UpdateGlobalBuffer_OnAudioIOStatusChanged ( bool bIsActive, FIntPoint IOId, uint32 AudioIOCount, FST_AudioIOData_GameThread & ST_AudioIOData_GT )

static

Updates the global buffer when the audio I/O status changes.

Parameters

bIsActive	The new status of the audio I/O (active or inactive).
IOId	The identifier for the I/O.
AudioIOCount	The count of active audio I/O.
ST_AudioIOData_GT	The audio I/O data to be updated on the game thread.

UpdateGlobalBuffer_OnBeatDetected()

void UST_AudioVisFunctionLibrary::UpdateGlobalBuffer_OnBeatDetected ( const TArray< float > & Beats, const TArray< bool > & BeatDetectedForChannel, FIntPoint IOId, FST_AudioIOData_GameThread & ST_AudioIOData_GT )

static

Updates the global buffer when a beat is detected.

Parameters

Beats	The array of BPM values.
BeatDetectedForChannel	An array of channels and if a beat was detected.
IOId	The identifier for the I/O.
ST_AudioIOData_GT	The audio I/O data to be updated on the game thread.

UpdateGlobalBuffer_OnFrequencyBandsReady()

void UST_AudioVisFunctionLibrary::UpdateGlobalBuffer_OnFrequencyBandsReady ( const TArray< float > & FrequencyBands, int32 NumFrequencyBands, FIntPoint IOId, FST_AudioIOData_GameThread & ST_AudioIOData_GT )

static

Updates the global buffer when frequency bands are ready.

Parameters

FrequencyBands	The array of frequency band values.
NumFrequencyBands	The number of frequency bands.
IOId	The identifier for the I/O.
ST_AudioIOData_GT	The audio I/O data to be updated on the game thread.

UpdateGlobalBuffer_OnPitchesReady()

void UST_AudioVisFunctionLibrary::UpdateGlobalBuffer_OnPitchesReady ( const TArray< float > & Pitches, FIntPoint IOId, FST_AudioIOData_GameThread & ST_AudioIOData_GT )

static

Updates the global buffer when pitch data is ready.

Parameters

Pitches	The array of pitch values.
IOId	The identifier for the I/O.
ST_AudioIOData_GT	The audio I/O data to be updated on 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/Main/ST_AudioVisFunctionLibrary.h
• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Private/Main/ST_AudioVisFunctionLibrary.cpp