UST_OSCManager Class Reference

Manages Open Sound Control (OSC) communication for ShaderTech's audio control system. More...

#include <ST_OSCManager.h>

Public Member Functions
	UST_OSCManager ()
bool	SendLEDOSCBlob (TArray< uint8 > LEDColourByteArray, FString Address)
bool	SendDummyOSCBlob (FString Address)
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_OSControlInterface
void	OnOSCItemRegistered ()
void	OnOSCItemDeregistered ()

Static Public Member Functions
static UST_OSCManager *	GetInstance (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	CreateClient ()
void	DestroyClient ()
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

Detailed Description

Manages Open Sound Control (OSC) communication for ShaderTech's audio control system.

Provides functionality to send OSC messages and blobs, manage the OSC client lifecycle, and respond to controller registration events. Extends UST_AudioControlManagerBase and implements IST_OSControlInterface.

See also

UOSCClient

Constructor & Destructor Documentation

UST_OSCManager()

UST_OSCManager::UST_OSCManager

(

)

Default constructor

Member Function Documentation

CreateClient()

void UST_OSCManager::CreateClient ( )

protected

Initializes and configures the internal OSC client used for sending messages.

DestroyClient()

void UST_OSCManager::DestroyClient ( )

protected

Cleans up and releases the internal OSC client instance.

GetInstance()

UST_OSCManager * UST_OSCManager::GetInstance ( const UObject * context )

static

Get the current OSC manager instance from a UObject context.

Parameters

context

The UObject to search from.

Returns

A pointer to the UST_OSCManager instance.

OnControllerDeregistered()

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

overrideprotectedvirtual

Called when an audio controller is deregistered.

Parameters

Controller	The audio controller being removed.
bAllControllersDeregistered	Whether this was the last registered controller.

Reimplemented from UST_AudioControlManagerBase.

OnControllerRegistered()

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

overrideprotectedvirtual

Called when an audio controller is registered.

Parameters

Controller	The audio controller being registered.
bFirstControllerRegistered	Whether this is the first controller registered.

Reimplemented from UST_AudioControlManagerBase.

OnManagedItemDeregistered()

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

overrideprotectedvirtual

Called when a managed item is deregistered from the audio system.

Parameters

ManagedItem	The object being removed.
bAllManagedItemDeregistered	Whether this was the last managed item.

Reimplemented from UST_AudioControlManagerBase.

OnManagedItemRegistered()

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

overrideprotectedvirtual

Called when a new managed item is registered with the audio system.

Parameters

ManagedItem	The object being registered.
bFirstManagedItemRegistered	Whether this is the first item being registered.

Reimplemented from UST_AudioControlManagerBase.

SendDummyOSCBlob()

bool UST_OSCManager::SendDummyOSCBlob

(

FString

Address

)

Send a dummy OSC blob to test connectivity or integration.

Parameters

Address

The OSC address to send the dummy message to.

Returns

true if the dummy message was successfully sent.

SendLEDOSCBlob()

bool UST_OSCManager::SendLEDOSCBlob	(	TArray< uint8 >	LEDColourByteArray,
		FString	Address )

Send an OSC blob message containing a byte array representing LED color data.

Parameters

LEDColourByteArray	Byte array to send as a blob.
Address	The OSC address to send the blob to.

Returns

true if the message was successfully sent.

Member Data Documentation

Fragment

TArray<uint8> UST_OSCManager::Fragment

protected

Internal buffer for temporarily storing byte data to send via OSC. Used by blob-based OSC transmission methods.

---

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

• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioControl/Public/OSC/ST_OSCManager.h
• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioControl/Private/OSC/ST_OSCManager.cpp