VJ Master 1.0
Real-time audio analysis and visualisation.
Loading...
Searching...
No Matches
UST_SocketManager Class Reference

Manages low-level socket communication for ShaderTech's audio control system. More...

#include <ST_SocketManager.h>

Public Member Functions

 UST_SocketManager ()
bool SendLEDUDPPacket (TArray< uint8 > LEDColourByteArray)
void SendDummyUDPPacket ()
void SendDummyStringUDPPacket ()
Public Member Functions inherited from UST_AudioControlManagerBase
 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.
Public Member Functions inherited from IST_SocketControlInterface
void OnSocketItemRegistered ()
void OnSocketItemDeregistered ()

Static Public Member Functions

static UST_SocketManagerGetInstance (const UObject *context)

Protected Member Functions

virtual void OnManagedItemRegistered (UObject *ManagedItem, bool bFirstManagedItemRegistered) override
virtual void OnManagedItemDeregistered (UObject *ManagedItem, bool bAllManagedItemDeregistered) override
virtual void OnControllerRegistered (FST_AudioController Controller, bool bFirstControllerRegistered) override
virtual void OnControllerDeregistered (FST_AudioController Controller, bool bAllControllersDeregistered) override
void CreateSocket ()
void DestroySocket ()
Protected Member Functions inherited from UST_AudioControlManagerBase
virtual void Initialize (FSubsystemCollectionBase &Collection) override
 Called when the subsystem is initialized.
virtual void Deinitialize () override
 Called before the subsystem is destroyed.

Protected Attributes

TArray< uint8 > Fragment
TArray< UObject * > SocketControls

Detailed Description

Manages low-level socket communication for ShaderTech's audio control system.

Responsible for sending UDP packets (e.g., for LED control) and handling the lifecycle of socket controls and connections. Implements the IST_SocketControlInterface to integrate with other socket-aware components.

Constructor & Destructor Documentation

◆ UST_SocketManager()

UST_SocketManager::UST_SocketManager ( )

Default constructor

Member Function Documentation

◆ CreateSocket()

void UST_SocketManager::CreateSocket ( )
protected

Initializes the UDP socket and prepares it for sending data.

◆ DestroySocket()

void UST_SocketManager::DestroySocket ( )
protected

Cleans up and closes the UDP socket connection.

◆ GetInstance()

UST_SocketManager * UST_SocketManager::GetInstance ( const UObject * context)
static

Get a reference to the global socket manager instance.

Parameters
contextThe UObject used to resolve the current world context.
Returns
A pointer to the UST_SocketManager instance.

◆ OnControllerDeregistered()

void UST_SocketManager::OnControllerDeregistered ( FST_AudioController Controller,
bool bAllControllersDeregistered )
overrideprotectedvirtual

Called when an audio controller is deregistered.

Parameters
ControllerThe removed controller data.
bAllControllersDeregisteredTrue if no other controllers remain.

Reimplemented from UST_AudioControlManagerBase.

◆ OnControllerRegistered()

void UST_SocketManager::OnControllerRegistered ( FST_AudioController Controller,
bool bFirstControllerRegistered )
overrideprotectedvirtual

Called when a new audio controller is registered.

Parameters
ControllerThe registered controller data.
bFirstControllerRegisteredTrue if this is the first registered controller.

Reimplemented from UST_AudioControlManagerBase.

◆ OnManagedItemDeregistered()

void UST_SocketManager::OnManagedItemDeregistered ( UObject * ManagedItem,
bool bAllManagedItemDeregistered )
overrideprotectedvirtual

Called when a previously registered item is removed.

Parameters
ManagedItemThe deregistered UObject.
bAllManagedItemDeregisteredTrue if no other managed items remain.

Reimplemented from UST_AudioControlManagerBase.

◆ OnManagedItemRegistered()

void UST_SocketManager::OnManagedItemRegistered ( UObject * ManagedItem,
bool bFirstManagedItemRegistered )
overrideprotectedvirtual

Called when a new item is registered with the socket manager (e.g., a listener or controller).

Parameters
ManagedItemThe registered UObject.
bFirstManagedItemRegisteredTrue if this is the first item being registered.

Reimplemented from UST_AudioControlManagerBase.

◆ SendDummyStringUDPPacket()

void UST_SocketManager::SendDummyStringUDPPacket ( )

Sends a dummy string-based UDP packet for testing or debugging string-based payloads.

◆ SendDummyUDPPacket()

void UST_SocketManager::SendDummyUDPPacket ( )

Sends a dummy UDP packet for testing purposes (e.g., empty or debug signal).

◆ SendLEDUDPPacket()

bool UST_SocketManager::SendLEDUDPPacket ( TArray< uint8 > LEDColourByteArray)

Sends a UDP packet containing raw LED color data.

Parameters
LEDColourByteArrayA byte array representing the LED colors to transmit.
Returns
True if the packet was sent successfully.

Member Data Documentation

◆ Fragment

TArray<uint8> UST_SocketManager::Fragment
protected

Internal buffer used to store the payload data for UDP transmission.

◆ SocketControls

TArray<UObject*> UST_SocketManager::SocketControls
protected

Holds references to socket-aware objects (e.g., receivers, handlers).


The documentation for this class was generated from the following files:
  • H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioControl/Public/Socket/ST_SocketManager.h
  • H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioControl/Private/Socket/ST_SocketManager.cpp