1. Epic GamesDeveloper
  3. UOSCManager

UOSCManager

API > API/Plugins > API/Plugins/OSC

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

Syntax

UCLASS ()  
class UOSCManager : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static FOSCMessage & AddAddress ( FOSCMessage& Message,
const FOSCAddress& Value
)

 Adds address (packed as string) value to end of OSCMessage OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Add OSC Address (As String) to OSC Message", Keywords="osc message")

static FOSCMessage & AddBlob ( FOSCMessage& Message,
const TArray< uint8 >& Value
)

 Adds blob value to end of OSCMessage OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Add Blob to OSC Message", Keywords="osc message")

static FOSCMessage & AddBool ( FOSCMessage& Message,
bool Value
)

 Adds boolean value to end of OSCMessage OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Add Bool to OSC Message", Keywords="osc message")

static FOSCBundle & AddBundleToBundle ( const FOSCBundle& InBundle,
FOSCBundle& OutBundle
)

 Adds bundle packet to bundle. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Add OSC Bundle to Bundle", Keywords="osc message")

static FOSCMessage & AddFloat ( FOSCMessage& Message,
float Value
)

 Adds float value to end of OSCMessage OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Add Float to OSC Message", Keywords="osc message")

static FOSCMessage & AddInt32 ( FOSCMessage& Message,
int32 Value
)

 Adds Int32 value to end of OSCMessage OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Add Integer to OSC Message", Keywords="osc message")

static FOSCMessage & AddInt64 ( FOSCMessage& Message,
int64 Value
)

 Adds Int64 value to end of OSCMessage OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Add Integer (64-bit) to OSC Message", Keywords="osc message")

static FOSCBundle & AddMessageToBundle ( const FOSCMessage& Message,
FOSCBundle& Bundle
)

 Adds provided message packet to bundle. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Add OSC Message to Bundle", Keywords="osc message bundle")

static FOSCMessage & AddString ( FOSCMessage& Message,
FString Value
)

 Adds string value to end of OSCMessage OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Add String to OSC Message", Keywords="osc message")

static FOSCBundle & ClearBundle ( FOSCBundle& Bundle
)

 Clears provided bundle of all internal messages/bundle packets. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Clear OSC Bundle", Keywords="osc message")

static FOSCMessage & ClearMessage ( FOSCMessage& Message
)

 Clears provided message of all arguments. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Clear OSC Message", Keywords="osc message")

static FOSCAddress & ClearOSCAddressContainers ( FOSCAddress& Address
)

 Clears containers of OSC Address provided OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Clear OSC Address Containers", Keywords="osc address clear")

static FOSCAddress ConvertStringToOSCAddress ( const FString& String
)

 Converts string to OSC Address OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"

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

 Creates an OSC Client. If SendIPAddress left empty (or '0') attempts to use LocalHost IP address. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"

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

 Creates an OSC Server. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"

static UObject * FindObjectAtOSCAddress ( const FOSCAddress& Address
)

 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. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Find Object at OSC Address", Keywords="osc address path uobject")

static bool GetAddress ( const FOSCMessage& Message,
const int32 Index,
FOSCAddress& Value
)

 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). OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Message Address At Index", Keywords="osc message")

static 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). OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Message Addresses", Keywords="osc message")

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

 Returns all boolean values in order of received from OSCMessage OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Message Bools", Keywords="osc message")

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

 Returns all float values in order of received from OSCMessage OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Message Floats", Keywords="osc message")

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

 Returns all integer values in order of received from OSCMessage OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Message Integers", Keywords="osc message")

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

 Returns all Int64 values in order of received from OSCMessage OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Message Integers (64-bit)", Keywords="osc message")

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

 Returns all string values in order of received from OSCMessage OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Message Strings", Keywords="osc message")

static bool GetBlob ( const FOSCMessage& Message,
const int32 Index,
TArray< uint8 >& Value
)

 Sets Value to blob at provided Index from OSCMessage if in bounds and type matches OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"

static bool GetBool ( const FOSCMessage& Message,
const int32 Index,
bool& Value
)

 Sets Value to boolean at provided Index from OSCMessage if in bounds and type matches OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Message Bool At Index", Keywords="osc message")

static TArray< FOSCBundle > GetBundlesFromBundle ( const FOSCBundle& Bundle
)

 Fills array with child bundles found in bundle. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Bundles From Bundle", Keywords="osc bundle")

static bool GetFloat ( const FOSCMessage& Message,
const int32 Index,
float& Value
)

 Set Value to float at provided Index in OSCMessage if in bounds and type matches OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Message Float At Index", Keywords="osc message")

static bool GetInt32 ( const FOSCMessage& Message,
const int32 Index,
int32& Value
)

 Set Value to integer at provided Index in OSCMessage if in bounds and type matches OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Message Integer at Index", Keywords="osc message")

static bool GetInt64 ( const FOSCMessage& Message,
const int32 Index,
int64& Value
)

 Set Value to Int64 at provided Index in OSCMessage if in bounds and type matches OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Message Integer (64-bit) at Index", Keywords="osc message")

static FOSCMessage GetMessageFromBundle ( const FOSCBundle& Bundle,
int32 Index,
bool& bSucceeded
)

 Returns message found in bundle at ordered index. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Message From Bundle At Index", Keywords="osc bundle message")

static TArray< FOSCMessage > GetMessagesFromBundle ( const FOSCBundle& Bundle
)

 Fills array with messages found in bundle. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Messages From Bundle", Keywords="osc bundle message")

static FString GetOSCAddressContainer ( const FOSCAddress& Address,
const int32 Index
)

 Returns the OSC Address container at the provided 'Index.' Returns empty string if index is out-of-bounds. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Address Container At Index", Keywords="osc address container path")

static FString GetOSCAddressContainerPath ( const FOSCAddress& Address
)

 Returns full path of OSC address in the form '/Container1/Container2/Method' OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"

static TArray< FString > GetOSCAddressContainers ( const FOSCAddress& Address
)

 Builds referenced array of address of containers in order OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Address Containers", Keywords="osc address container path")

static FString GetOSCAddressFullPath ( const FOSCAddress& Address
)

 Returns full path of OSC address in the form '/Container1/Container2' OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Convert OSC Address To String")

static FString GetOSCAddressMethod ( const FOSCAddress& Address
)

 Returns method name of OSC Address provided OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Address Method")

static FOSCAddress GetOSCMessageAddress ( const FOSCMessage& Message
)

 Returns copy of message's OSC Address OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Message Address", Keywords="osc address")

static bool GetString ( const FOSCMessage& Message,
const int32 Index,
FString& Value
)

 Set Value to string at provided Index in OSCMessage if in bounds and type matches OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Get OSC Message String at Index", Keywords="osc message")

static FString ObjectPathFromOSCAddress ( const FOSCAddress& Address
)

 Converts OSC Address to an object path. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Convert OSC Address to Object Path", Keywords="osc address path uobject")
Converts object path to OSC Address, converting folders to address containers and the object's name to the address method. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Convert Object Path to OSC Address", Keywords="osc address path uobject")
Converts object path string to OSC Address, converting folders to address containers and the object's name to the address method. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Convert Object Path (String) to OSC Address", Keywords="osc address path uobject")

static bool OSCAddressIsValidPath ( const FOSCAddress& Address
)

 Returns whether OSC Address is valid path OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Is OSC Address Valid Path", Keywords="valid osc address path address")

static bool OSCAddressIsValidPattern ( const FOSCAddress& Address
)

 Returns whether OSC Address is valid pattern to match against OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Is OSC Address Valid Pattern", Keywords="valid osc address pattern address")

static bool OSCAddressPathMatchesPattern ( const FOSCAddress& Pattern,
const FOSCAddress& Path
)

 Returns if address pattern matches the provided address path. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="OSC Address Path Matches Pattern", Keywords="matches osc address path address")

static FString OSCAddressPopContainer ( FOSCAddress& Address
)

 Pops container from ordered array of containers. If no containers, returns empty string OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Pop Container from OSC Address", Keywords="pop osc address container")

static TArray< FString > OSCAddressPopContainers ( FOSCAddress& Address,
int32 NumContainers
)

 Pops container from ordered array of containers. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Pop Containers from OSC Address", Keywords="pop osc address container")

static FOSCAddress & OSCAddressPushContainer ( FOSCAddress& Address,
const FString& Container
)

 Pushes container onto address' ordered array of containers OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Push Container to OSC Address", Keywords="push osc address container")

static FOSCAddress & OSCAddressPushContainers ( FOSCAddress& Address,
const TArray< FString >& Containers
)

 Pushes container onto address' ordered array of containers OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Push Container Array to OSC Address", Keywords="push osc address container")

static FOSCAddress & OSCAddressRemoveContainers ( FOSCAddress& Address,
int32 Index,
int32 Count
)

 Remove containers from ordered array of containers at index up to count of containers. OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Remove Containers from OSC Address", Keywords="remove osc address container")

static FOSCAddress & SetOSCAddressMethod ( FOSCAddress& Address,
const FString& Method
)

 Sets the method name of the OSC Address provided OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"
  • Meta=(DisplayName="Set OSC Address Method", Keywords="osc method")

static FOSCMessage & SetOSCMessageAddress ( FOSCMessage& Message,
const FOSCAddress& Address
)

 Sets the OSC Address of the provided message OSCManager.h
  • BlueprintCallable
  • Category="Audio|OSC"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page