1. Epic GamesDeveloper
  3. UOSCServer

UOSCServer

Unreal Engine C++ API Reference > Plugins > OSC

Inheritance Hierarchy

References

   
Module OSC
Header /Engine/Plugins/Runtime/OSC/Source/OSC/Public/OSCServer.h
Include #include "OSCServer.h"

Syntax

UCLASS&40;BlueprintType&41;  
class UOSCServer : public UObject

Variables

  Type Name Description
Public variable UProperty Category BlueprintAssignable FOSCReceivedBundleEvent OnOscBundleReceived Event that gets called when an OSC bundle is received.
Public variable FOSCReceivedBundleNativeEvent OnOscBundleReceivedNative Native event that gets called when an OSC bundle is received.
Public variable UProperty Category BlueprintAssignable FOSCReceivedMessageEvent OnOscMessageReceived Event that gets called when an OSC message is received.
Public variable FOSCReceivedMessageNativeEvent OnOscMessageReceivedNative Native event that gets called when an OSC message is received.

Constructors

  Type Name Description
Public function  

UOSCServer ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

AddAllowlistedClient ( const FString& IPAddress
)

 Adds client to allowlist of clients to listen for.
Public function UFunction BlueprintCallable, Category void Adds event to dispatch when OSCAddressPattern is matched.
Public function UFunction BlueprintCallable, Category void Clears client allowlist to listen for.
Public function void Clears all packets pending processing
Public function void Enqueues packet to be processed
Public function Const UFunction BlueprintCallable, Category TSet< FString > Returns set of allowlisted clients.
Public function Const UFunction BlueprintCallable, Category TArray< FOSCAddress > Returns set of OSCAddressPatterns currently listening for matches to dispatch.
Public function Const UFunction BlueprintCallable, Category FString

GetIpAddress ( bool bIncludePort
)

 Returns the IP for the server if connected as a string.
Public function Const UFunction BlueprintCallable, Category bool Gets whether or not to loopback if ReceiveIPAddress provided is multicast.
Public function Const UFunction BlueprintCallable, Category int32

GetPort ()

 Returns the port for the server if connected.
Public function Const UFunction BlueprintCallable, Category bool Returns whether server is actively listening to incoming messages.
Public function UFunction BlueprintCallable, Category void

Listen ()

 Sets the IP address and port to listen for OSC data.
Public function void

PumpPacketQueue ( const TSet< uint32 >* InAllowlistedClients
)

 Callback for when packet is received by server
Public function UFunction BlueprintCallable, Category void

RemoveAllowlistedClient ( const FString& IPAddress
)

 Removes allowlisted client to listen for.
Public function UFunction BlueprintCallable, Category bool

SetAddress ( const FString& ReceiveIPAddress,
int32 Port
)

 Set the address and port of server. Fails if server is currently active.
Public function UFunction BlueprintCallable, Category void

SetAllowlistClientsEnabled ( bool bEnabled
)

 When set to true, server will only process received messages from allowlisted clients.
Public function UFunction BlueprintCallable, Category void

SetMulticastLoopback ( bool bMulticastLoopback
)

 Set whether or not to loopback if ReceiveIPAddress provided is multicast.
Public function UFunction BlueprintCallable, Category 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).
Public function UFunction BlueprintCallable, Category void

Stop ()

 Stop and tidy up network socket.
Public function UFunction BlueprintCallable, Category void Removes OSCAddressPattern from sending dispatch events.
Public function UFunction BlueprintCallable, Category void Removes all events from OSCAddressPatterns to dispatch.
Public function UFunction BlueprintCallable, Category void Unbinds specific event from OSCAddress pattern.

Overridden from UObject

  Type Name Description
Protected function Virtual void Called before destroying the object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page