1. Epic GamesDeveloper
  3. UOSCManager

UOSCManager

API > API/Plugins > API/Plugins/OSC

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;&41;  
class UOSCManager : public UBlueprintFunctionLibrary

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category, Meta FOSCMessage &

AddAddress ( FOSCMessage& Message,
const FOSCAddress& Value
)

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

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

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

AddBool ( FOSCMessage& Message,
bool Value
)

 Adds boolean value to end of OSCMessage
Public function Static UFunction BlueprintCallable, Category, Meta FOSCBundle &

AddBundleToBundle ( const FOSCBundle& InBundle,
FOSCBundle& OutBundle
)

 Adds bundle packet to bundle.
Public function Static UFunction BlueprintCallable, Category, Meta FOSCMessage &

AddFloat ( FOSCMessage& Message,
float Value
)

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

AddInt32 ( FOSCMessage& Message,
int32 Value
)

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

AddInt64 ( FOSCMessage& Message,
int64 Value
)

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

AddMessageToBundle ( const FOSCMessage& Message,
FOSCBundle& Bundle
)

 Adds provided message packet to bundle.
Public function Static UFunction BlueprintCallable, Category, Meta FOSCMessage &

AddString ( FOSCMessage& Message,
FString Value
)

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

ClearBundle ( FOSCBundle& Bundle
)

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

ClearMessage ( FOSCMessage& Message
)

 Clears provided message of all arguments.
Public function Static UFunction BlueprintCallable, Category, Meta FOSCAddress & Clears containers of OSC Address provided
Public function Static UFunction BlueprintCallable, Category FOSCAddress Converts string to OSC Address
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 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.
Public function Static UFunction BlueprintCallable, Category, Meta 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).
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 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
Public function Static UFunction BlueprintCallable, Category, Meta 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
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FOSCBundle >

GetBundlesFromBundle ( const FOSCBundle& Bundle
)

 Fills array with child bundles found in bundle.
Public function Static UFunction BlueprintCallable, Category, Meta 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
Public function Static UFunction BlueprintCallable, Category, Meta 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
Public function Static UFunction BlueprintCallable, Category, Meta 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
Public function Static UFunction BlueprintCallable, Category, Meta FOSCMessage

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

 Returns message found in bundle at ordered index.
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FOSCMessage >

GetMessagesFromBundle ( const FOSCBundle& Bundle
)

 Fills array with messages found in bundle.
Public function Static UFunction BlueprintCallable, Category, Meta 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.
Public function Static UFunction BlueprintCallable, Category FString Returns full path of OSC address in the form '/Container1/Container2/Method'
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FString > Builds referenced array of address of containers in order
Public function Static UFunction BlueprintCallable, Category, Meta FString

GetOSCAddressFullPath ( const FOSCAddress& Address
)

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

GetOSCAddressMethod ( const FOSCAddress& Address
)

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

GetOSCMessageAddress ( const FOSCMessage& Message
)

 Returns copy of message's OSC Address
Public function Static UFunction BlueprintCallable, Category, Meta 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
Public function Static UFunction BlueprintCallable, Category, Meta FString Converts OSC Address to an object path.
Public function Static UFunction BlueprintCallable, Category, Meta FOSCAddress Converts object path to OSC Address, converting folders to address containers and the object's name to the address method.
Public function Static UFunction BlueprintCallable, Category, Meta FOSCAddress Converts object path string to OSC Address, converting folders to address containers and the object's name to the address method.
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 UFunction BlueprintCallable, Category, Meta bool

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

 Returns if address pattern matches the provided address path.
Public function Static UFunction BlueprintCallable, Category, Meta FString Pops container from ordered array of containers. If no containers, returns empty string
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FString >

OSCAddressPopContainers ( FOSCAddress& Address,
int32 NumContainers
)

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

OSCAddressPushContainer ( FOSCAddress& Address,
const FString& Container
)

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

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

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

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

 Remove containers from ordered array of containers at index up to count of containers.
Public function Static UFunction BlueprintCallable, Category, Meta FOSCAddress &

SetOSCAddressMethod ( FOSCAddress& Address,
const FString& Method
)

 Sets the method name of the OSC Address provided
Public function Static UFunction BlueprintCallable, Category FOSCMessage &

SetOSCMessageAddress ( FOSCMessage& Message,
const FOSCAddress& Address
)

 Sets the OSC Address of the provided message

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page