UST_AudioScene Class Reference

Audio scene subsystem that manages audio processing and scene view extensions. This class is responsible for initializing and deinitializing the audio scene, handling world lifecycle events, and managing audio IO and processing events. More...

#include <ST_AudioScene.h>

Public Member Functions
virtual void	Initialize (FSubsystemCollectionBase &Collection) override
virtual void	Deinitialize () override
TSharedPtr< class FST_AudioSceneViewExtension >	GetSceneViewExtension () const
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.

Protected Member Functions
void	HandlePostWorldInit (UWorld *World, const UWorld::InitializationValues IVS)
void	HandleWorldEndPlay (UWorld *World, bool bSessionEnded, bool bCleanupResources)

Protected Attributes
TSharedPtr< class FST_AudioSceneViewExtension, ESPMode::ThreadSafe >	ViewExtension

Detailed Description

Audio scene subsystem that manages audio processing and scene view extensions. This class is responsible for initializing and deinitializing the audio scene, handling world lifecycle events, and managing audio IO and processing events.

Member Function Documentation

Deinitialize()

void UST_AudioScene::Deinitialize ( )

overridevirtual

Deinitializes the audio scene subsystem. Called when the subsystem is deinitialized.

GetSceneViewExtension()

TSharedPtr< class FST_AudioSceneViewExtension > UST_AudioScene::GetSceneViewExtension ( ) const

inline

Gets the scene view extension for this audio scene.

Returns

A shared pointer to the scene view extension.

HandlePostWorldInit()

void UST_AudioScene::HandlePostWorldInit ( UWorld * World, const UWorld::InitializationValues IVS )

protected

Called when the game world begins play. Handles initialization for the audio scene.

Parameters

World	The world object that is being initialized.
IVS	The initialization values for the world.

HandleWorldEndPlay()

void UST_AudioScene::HandleWorldEndPlay ( UWorld * World, bool bSessionEnded, bool bCleanupResources )

protected

Called when the game world ends or is being cleaned up.

Parameters

World	The world object that is ending play.
bSessionEnded	Whether the session ended.
bCleanupResources	Whether resources should be cleaned up.

Initialize()

void UST_AudioScene::Initialize ( FSubsystemCollectionBase & Collection )

overridevirtual

Initializes the audio scene subsystem. Called when the subsystem is initialized.

Parameters

Collection

The collection of subsystems this belongs to.

Member Data Documentation

ViewExtension

TSharedPtr<class FST_AudioSceneViewExtension, ESPMode::ThreadSafe> UST_AudioScene::ViewExtension

protected

The audio scene view extension, used for rendering audio-related visuals. This is a thread-safe pointer to the view extension.

---

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

• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Public/Material/SUB/ST_AudioScene.h
• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Private/Material/SUB/ST_AudioScene.cpp