1. Epic GamesDeveloper
  3. UOSCManager

UOSCManager

API > API/Plugins > API/Plugins/OSC

Inheritance Hierarchy

  • UBlueprintFunctionLibrary
  • UOSCManager

References

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

Syntax

UCLASS ()  
class UOSCManager : public UBlueprintFunctionLibrary

Variables

  Type Name Description
Public variable const FOSCAddress & Address  
Public variable int32 bool & bSucceeded  
Public variable const FString & Container  
Public variable const TArray< FString > & Containers  
Public variable int32 int32 Count  
Public variable const int32 Index  
Public variable int32 Index  
Public variable const FString & Method  
Public variable int32 NumContainers  
Public variable const FOSCAddress & Path  
Public variable const int32 bool & Value  
Public variable const int32 FString & Value  
Public variable const int32 int64 & Value  
Public variable const int32 int32 & Value  
Public variable const int32 float & Value  
Public variable const int32 FOSCAddress & Value  
Public variable bool Value  
Public variable const TArray< uint8 > & Value  
Public variable const FOSCAddress & Value  
Public variable int64 Value  
Public variable int32 Value  
Public variable float Value  
Public variable const int32 TArray< uint8 > & Value  

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category UOSCClient *

CreateOSCClient ( FString SendIPAddress,
int32 Port,
FString ClientName,
UObject* Outer
)

 Creates an OSC Client.
Public function Static UFunction BlueprintCallable, Category UOSCServer *

CreateOSCServer ( FString ReceiveIPAddress,
int32 Port,
bool bMulticastLoopback,
bool bStartListening,
FString ServerName,
UObject* Outer
)

 Creates an OSC Server.
Public function Static UFunction BlueprintCallable, Category, Meta void

GetAllAddresses ( const FOSCMessage& Message,
TArray< FOSCAddress >& Values
)

 Returns all strings that are valid address paths in order received from OSCMessage (Does NOT include address of message, just strings packed in message that are valid paths).
Public function Static UFunction BlueprintCallable, Category, Meta void

GetAllBools ( const FOSCMessage& Message,
TArray< bool >& Values
)

 Returns all boolean values in order of received from OSCMessage
Public function Static UFunction BlueprintCallable, Category, Meta void

GetAllFloats ( const FOSCMessage& Message,
TArray< float >& Values
)

 Returns all float values in order of received from OSCMessage
Public function Static UFunction BlueprintCallable, Category, Meta void

GetAllInt32s ( const FOSCMessage& Message,
TArray< int32 >& Values
)

 Returns all integer values in order of received from OSCMessage
Public function Static UFunction BlueprintCallable, Category, Meta void

GetAllInt64s ( const FOSCMessage& Message,
TArray< int64 >& Values
)

 Returns all Int64 values in order of received from OSCMessage
Public function Static UFunction BlueprintCallable, Category, Meta void

GetAllStrings ( const FOSCMessage& Message,
TArray< FString >& Values
)

 Returns all string values in order of received from OSCMessage
Public function Static UFunction BlueprintCallable, Category, Meta bool

OSCAddressIsValidPath ( const FOSCAddress& Address
)

 Returns whether OSC Address is valid path
Public function Static UFunction BlueprintCallable, Category, Meta bool Returns whether OSC Address is valid pattern to match against
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Finds an object with the given OSC Address in path form, where containers correspond to path folders and the the address method to the object's name.
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Converts object path to OSC Address, converting folders to address containers and the object's name to the address method.
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Converts object path string to OSC Address, converting folders to address containers and the object's name to the address method.
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Converts OSC Address to an object path.
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Pushes container onto address' ordered array of containers
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Pushes container onto address' ordered array of containers
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Pops container from ordered array of containers. If no containers, returns empty string
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Pops container from ordered array of containers.
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Remove containers from ordered array of containers at index up to count of containers.
Public function Static Const UFunction BlueprintCallable, Category static

UPARAM ( DisplayName
)

 Returns full path of OSC address in the form '/Container1/Container2/Method'
Public function Static UFunction BlueprintCallable, Category static

UPARAM ( DisplayName
)

 Sets the OSC Address of the provided message
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Returns the OSC Address container at the provided 'Index.' Returns empty string if index is out-of-bounds.
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Builds referenced array of address of containers in order
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Returns if address pattern matches the provided address path.
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Returns full path of OSC address in the form '/Container1/Container2'
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Returns method name of OSC Address provided
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Clears containers of OSC Address provided
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Sets the method name of the OSC Address provided
Public function UFunction BlueprintCallable, Category, Meta static

UPARAM ( ref
)

  
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Returns copy of message's OSC Address
Public function Static Const UFunction BlueprintCallable, Category static

UPARAM ( DisplayName
)

 Converts string to OSC Address
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Set Value to integer at provided Index in OSCMessage if in bounds and type matches
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Sets Value to boolean at provided Index from OSCMessage if in bounds and type matches
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Adds provided message packet to bundle.
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Adds bundle packet to bundle.
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Fills array with child bundles found in bundle.
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Returns message found in bundle at ordered index.
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Fills array with messages found in bundle.
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Clears provided message of all arguments.
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Clears provided bundle of all internal messages/bundle packets.
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Adds float value to end of OSCMessage
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Adds Int32 value to end of OSCMessage
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Adds Int64 value to end of OSCMessage
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Adds address (packed as string) value to end of OSCMessage
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Adds string value to end of OSCMessage
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Adds blob value to end of OSCMessage
Public function Static UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Adds boolean value to end of OSCMessage
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Sets Value to address at provided Index in OSCMessage if in bounds and OSC type matches 'String' (Does NOT return address of message, rather string packed in message and casts to OSC address).
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Set Value to float at provided Index in OSCMessage if in bounds and type matches
Public function UFunction BlueprintCallable, Category, Meta static

UPARAM ( ref
)

  
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Set Value to Int64 at provided Index in OSCMessage if in bounds and type matches
Public function Static Const UFunction BlueprintCallable, Category, Meta static

UPARAM ( DisplayName
)

 Set Value to string at provided Index in OSCMessage if in bounds and type matches
Public function Static Const UFunction BlueprintCallable, Category static

UPARAM ( DisplayName
)

 Sets Value to blob at provided Index from OSCMessage if in bounds and type matches
Public function UFunction BlueprintCallable, Category, Meta static

UPARAM ( ref
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page