Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OSC > UOSCServer

Light Theme

Dark Theme

UOSCServer

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UOSCServer

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType)
class UOSCServer : public UObject

Variables

	Name	Description
FOSCReceivedBun...	OnOscBundleReceived	Event that gets called when an OSC bundle is received.
FOSCReceivedBun...	OnOscBundleReceivedNative	Native event that gets called when an OSC bundle is received.
FOSCReceivedMes...	OnOscMessageReceived	Event that gets called when an OSC message is received.
FOSCReceivedMes...	OnOscMessageReceivedNative	Native event that gets called when an OSC message is received.

Constructors

	Name	Description
	UOSCServer ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddWhitelistedClient ( const FString& IPAddress )	Adds client to whitelist of clients to listen for.
void	BindEventToOnOSCAddressPatternMatchesPath ( const FOSCAddress& OSCAddressPatte..., const FOSCDispatchMessageEventBP& ... )	Adds event to dispatch when OSCAddressPattern is matched.
void	ClearPackets()	Clears all packets pending processing
void	ClearWhitelistedClients()	Clears client whitelist to listen for.
void	EnqueuePacket ( TSharedPtr< IOSCPacket > InPacket )	Enqueues packet to be processed
TArray< FOSC...	GetBoundOSCAddressPatterns()	Returns set of OSCAddressPatterns currently listening for matches to dispatch.
FString	GetIpAddress ( bool bIncludePort )	Returns the IP for the server if connected as a string.
bool	GetMulticastLoopback()	Gets whether or not to loopback if ReceiveIPAddress provided is multicast.
int32	GetPort()	Returns the port for the server if connected.
TSet< FStrin...	GetWhitelistedClients()	Returns set of whitelisted clients.
bool	IsActive()	Returns whether server is actively listening to incoming messages.
void	Listen()	Sets the IP address and port to listen for OSC data.
void	PumpPacketQueue ( const TSet< uint32 >* InWhitel... )	Callback for when packet is received by server
void	RemoveWhitelistedClient ( const FString& IPAddress )	Removes whitelisted client to listen for.
bool	SetAddress ( const FString& ReceiveIPAddress, int32 Port )	Set the address and port of server. Fails if server is currently active.
void	SetMulticastLoopback ( bool bMulticastLoopback )	Set whether or not to loopback if ReceiveIPAddress provided is multicast.
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).
void	SetWhitelistClientsEnabled ( bool bEnabled )	When set to true, server will only process received messages from whitelisted clients.
void	Stop()	Stop and tidy up network socket.
void	UnbindAllEventsFromOnOSCAddressPatternMatchesPath ( const FOSCAddress& OSCAddressPatte... )	Removes OSCAddressPattern from sending dispatch events.
void	UnbindAllEventsFromOnOSCAddressPatternMatching()	Removes all events from OSCAddressPatterns to dispatch.
void	UnbindEventFromOnOSCAddressPatternMatchesPath ( const FOSCAddress& OSCAddressPatte..., const FOSCDispatchMessageEventBP& ... )	Unbinds specific event from OSCAddress pattern.

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss