UST_AudioControlManagerBase Class Reference

Abstract base class for managing audio control subsystems. More...

#include <ST_AudioControlManagerBase.h>

Public Member Functions
	UST_AudioControlManagerBase ()
	Constructor for UST_AudioControlManagerBase.
bool	RegisterManagedItem (UObject *ManagedItem)
	Registers a managed item with the subsystem.
bool	DeregisterManagedItem (UObject *ManagedItem)
	Deregisters a managed item from the subsystem.
bool	RegisterController (FST_AudioController Controller)
	Registers an audio controller with the subsystem.
bool	DeregisterController (FST_AudioController Controller)
	Deregisters an audio controller from the subsystem.
const TArray< UObject * > &	GetManagedItems () const
	Gets the list of currently managed items.
const TArray< FST_AudioController > &	GetRegisteredControllers () const
	Gets the list of currently registered controllers.

Protected Member Functions
virtual void	Initialize (FSubsystemCollectionBase &Collection) override
	Called when the subsystem is initialized.
virtual void	Deinitialize () override
	Called before the subsystem is destroyed.
virtual void	OnManagedItemRegistered (UObject *ManagedItem, bool bFirstManagedItemRegistered)
	Called internally when a managed item is registered.
virtual void	OnManagedItemDeregistered (UObject *ManagedItem, bool bAllManagedItemDeregistered)
	Called internally when a managed item is deregistered.
virtual void	OnControllerRegistered (FST_AudioController Controller, bool bFirstControllerRegistered)
	Called internally when a controller is registered.
virtual void	OnControllerDeregistered (FST_AudioController Controller, bool bAllControllersDeregistered)
	Called internally when a controller is deregistered.

Detailed Description

Abstract base class for managing audio control subsystems.

UST_AudioControlManagerBase provides core functionality for registering and deregistering managed audio control items and controllers. It serves as a foundation for systems that require coordinated control of audio or DMX elements.

Member Function Documentation

Deinitialize()

void UST_AudioControlManagerBase::Deinitialize ( )

overrideprotectedvirtual

Called before the subsystem is destroyed.

This function is triggered during shutdown to clean up resources.

DeregisterController()

bool UST_AudioControlManagerBase::DeregisterController

(

FST_AudioController

Controller

)

Deregisters an audio controller from the subsystem.

Parameters

Controller

The audio controller to deregister.

Returns

True if deregistration was successful; false otherwise.

DeregisterManagedItem()

bool UST_AudioControlManagerBase::DeregisterManagedItem

(

UObject *

ManagedItem

)

Deregisters a managed item from the subsystem.

Parameters

ManagedItem

The UObject to deregister.

Returns

True if deregistration was successful; false otherwise.

GetManagedItems()

const TArray< UObject * > & UST_AudioControlManagerBase::GetManagedItems ( ) const

inline

Gets the list of currently managed items.

Returns

A const reference to the array of managed UObjects.

GetRegisteredControllers()

const TArray< FST_AudioController > & UST_AudioControlManagerBase::GetRegisteredControllers ( ) const

inline

Gets the list of currently registered controllers.

Returns

A const reference to the array of registered controllers.

Initialize()

void UST_AudioControlManagerBase::Initialize ( FSubsystemCollectionBase & Collection )

overrideprotectedvirtual

Called when the subsystem is initialized.

This function is triggered when the game instance subsystem is created.

Parameters

Collection

A reference to the subsystem collection.

OnControllerDeregistered()

void UST_AudioControlManagerBase::OnControllerDeregistered ( FST_AudioController Controller, bool bAllControllersDeregistered )

protectedvirtual

Called internally when a controller is deregistered.

Parameters

Controller	The controller that was deregistered.
bAllControllersDeregistered	Whether all controllers have been deregistered.

Reimplemented in UST_DMXManager, UST_MIDIManager, UST_OSCManager, and UST_SocketManager.

OnControllerRegistered()

void UST_AudioControlManagerBase::OnControllerRegistered ( FST_AudioController Controller, bool bFirstControllerRegistered )

protectedvirtual

Called internally when a controller is registered.

Parameters

Controller	The controller that was registered.
bFirstControllerRegistered	Whether this is the first registered controller.

Reimplemented in UST_DMXManager, UST_MIDIManager, UST_OSCManager, and UST_SocketManager.

OnManagedItemDeregistered()

void UST_AudioControlManagerBase::OnManagedItemDeregistered ( UObject * ManagedItem, bool bAllManagedItemDeregistered )

protectedvirtual

Called internally when a managed item is deregistered.

Parameters

ManagedItem	The item that was deregistered.
bAllManagedItemDeregistered	Whether all managed items have been deregistered.

Reimplemented in UST_DMXManager, UST_MIDIManager, UST_OSCManager, and UST_SocketManager.

OnManagedItemRegistered()

void UST_AudioControlManagerBase::OnManagedItemRegistered ( UObject * ManagedItem, bool bFirstManagedItemRegistered )

protectedvirtual

Called internally when a managed item is registered.

Parameters

ManagedItem	The item that was registered.
bFirstManagedItemRegistered	Whether this is the first registered item.

Reimplemented in UST_DMXManager, UST_MIDIManager, UST_OSCManager, and UST_SocketManager.

RegisterController()

bool UST_AudioControlManagerBase::RegisterController

(

FST_AudioController

Controller

)

Registers an audio controller with the subsystem.

Parameters

Controller

The audio controller to register.

Returns

True if registration was successful; false otherwise.

RegisterManagedItem()

bool UST_AudioControlManagerBase::RegisterManagedItem

(

UObject *

ManagedItem

)

Registers a managed item with the subsystem.

Parameters

ManagedItem

The UObject to register.

Returns

True if registration was successful; false otherwise.

---

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

• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioControl/Public/Main/Base/ST_AudioControlManagerBase.h
• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioControl/Private/Main/Base/ST_AudioControlManagerBase.cpp