1. Epic GamesDeveloper
  3. UOSCServer

UOSCServer

API > API/Plugins > API/Plugins/OSC

   
Name UOSCServer
Type class
Header File /Engine/Plugins/Runtime/OSC/Source/OSC/Public/OSCServer.h
Include Path #include "OSCServer.h"

Syntax

UCLASS (BlueprintType)  
class UOSCServer : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UOSCServer ( const FObjectInitializer& ObjectInitializer
)

   OSCServer.h  

Typedefs

Name Type Remarks Include Path
FPacketQueue TSpscQueue< TSharedPtr< UE::OSC::IPacket > >   OSCServer.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnOscBundleReceived FOSCReceivedBundleEvent Event that gets called when an OSC bundle is received. OSCServer.h
  • BlueprintAssignable
  • Category="Audio|OSC"
OnOscBundleReceivedNative FOSCReceivedBundleNativeEvent Native event that gets called when an OSC bundle is received. OSCServer.h  
OnOscMessageReceived FOSCReceivedMessageEvent Event that gets called when an OSC message is received. OSCServer.h
  • BlueprintAssignable
  • Category="Audio|OSC"
OnOscMessageReceivedNative FOSCReceivedMessageNativeEvent Native event that gets called when an OSC message is received. OSCServer.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AddressPatterns TMap< FOSCAddress, FOSCDispatchMessageEvent > Address pattern hash to check against when dispatching incoming messages OSCServer.h  
OSCPackets TSharedPtr< FPacketQueue > Queue stores incoming OSC packet requests to process on the game thread. OSCServer.h  
ServerProxy TSharedPtr< UE::OSC::IServerProxy > Pointer to internal implementation of server proxy OSCServer.h  
TickHandle FTSTicker::FDelegateHandle   OSCServer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddAllowlistedClient ( const FString& IPAddress,
int32 IPPort
)

 Adds client to allowlist of clients to listen for. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

void BindEventToOnOSCAddressPatternMatchesPath ( const FOSCAddress& OSCAddressPattern,
const FOSCDispatchMessageEventBP& Event
)

 Adds event to dispatch when OSCAddressPattern is matched. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

void ClearAllowlistedClients()

 Clears client allowlist to listen for. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

void ClearPackets()

   OSCServer.h  

void EnqueuePacket ( TSharedPtr< UE::OSC::IPacket > InPacket
)

   OSCServer.h  

TSet< FString > GetAllowlistedClients ( bool bIncludePort
) const

 Returns set of allowlisted endpoint clients as strings with (optional) port included. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

TArray< FOSCAddress > GetBoundOSCAddressPatterns()

 Returns set of OSCAddressPatterns currently listening for matches to dispatch. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

FString GetIpAddress ( bool bIncludePort
) const

 Returns the IP for the server if connected as a string. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

bool GetMulticastLoopback()

 Gets whether or not to loopback if ReceiveIPAddress provided is multicast. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

int32 GetPort()

 Returns the port for the server if connected. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

bool IsActive()

 Returns whether server is actively listening to incoming messages. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

void Listen()

 Sets the IP address and port to listen for OSC data. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

void PumpPacketQueue ( const TSet< uint32 >* InAllowlistedClients
)

   OSCServer.h  

void RemoveAllowlistedClient ( const FString& IPAddress,
int32 IPPort
)

 Removes allowlisted client to listen for. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

bool SetAddress ( const FString& ReceiveIPAddress,
int32 Port
)

 Set the address and port of server. Fails if server is currently active. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

void SetAllowlistClientsEnabled ( bool bEnabled
)

 When set to true, server will only process received messages from allowlisted clients. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

void SetMulticastLoopback ( bool bMulticastLoopback
)

 Set whether or not to loopback if ReceiveIPAddress provided is multicast. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

void SetTickInEditor ( bool bInTickInEditor
)

 Set whether server instance can be ticked in-editor (editor only and available to blueprint for use in editor utility scripts/script actions). OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(Deprecated="5.5", DeprecationMessage="Servers are now implemented as dispatchers, which are pumped on an async task upon calling 'Listen' at a provided rate (i.e. no longer 'ticked' on the game thread). See 'SetUpdateRate'")

void Stop()

 Stop and tidy up network socket. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

void UnbindAllEventsFromOnOSCAddressPatternMatchesPath ( const FOSCAddress& OSCAddressPattern
)

 Removes OSCAddressPattern from sending dispatch events. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

void UnbindAllEventsFromOnOSCAddressPatternMatching()

 Removes all events from OSCAddressPatterns to dispatch. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

void UnbindEventFromOnOSCAddressPatternMatchesPath ( const FOSCAddress& OSCAddressPattern,
const FOSCDispatchMessageEventBP& Event
)

 Unbinds specific event from OSCAddress pattern. OSCServer.h
  • BlueprintCallable
  • Category="Audio|OSC"

Protected

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   OSCServer.h  

virtual void PostInitProperties()

   OSCServer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page