1. Epic GamesDeveloper
  3. FOSCAddress

FOSCAddress

API > API/Plugins > API/Plugins/OSC

References

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

Syntax

USTRUCT (BlueprintType )  
struct FOSCAddress

Constructors

  Type Name Description
Public function    
Public function  

FOSCAddress ( const FString& InValue
)

  

Functions

  Type Name Description
Public function void Clears ordered array of containers
Public function Const FString

GetContainer ( int32 Index
)

 Returns container at provided Index. If Index is out-of-bounds, returns empty string.
Public function Const FString Returns container path of OSC address in the form '/Container1/Container2'
Public function Const void

GetContainers ( TArray< FString >& OutContainers
)

 Builds referenced array of address of containers in order
Public function Const FString Returns full path of OSC address in the form '/Container1/Container2/Method'
Public function Const const FString & Get method name of address
Public function Const bool

GetNumericPrefix ( int32& OutPrefix
)

 Returns numeric prefix of OSC method if is numeric
Public function Const bool

GetNumericSuffix ( int32& OutSuffix
)

 Returns numeric suffix of OSC method if is numeric
Public function Const bool Returns whether address is valid path
Public function Const bool Returns whether address is valid pattern
Public function Const bool

Matches ( const FOSCAddress& InAddress
)

 Returns if this address is a pattern that matches InAddress' path.
Public function FString Pops container from ordered array of containers
Public function bool

PopContainer ( FString& OutContainer
)

 Pops container from ordered array of containers
Public function TArray< FString >

PopContainers ( int32 NumToPop
)

 Pops containers off end of address' ordered array of containers
Public function bool

PopContainers ( int32 NumToPop,
TArray< FString >& OutContainers
)

 Pops containers off end of address' ordered array of containers
Public function bool

PushContainer ( FString Container
)

 Pushes container onto end of address' ordered array of containers
Public function bool

PushContainers ( TArray< FString > NewContainers
)

 Pushes containers onto end of address' ordered array of containers
Public function bool

RemoveContainers ( int32 InIndex,
int32 InCount
)

 Removes containers from container array at index until count
Public function bool

Set ( TArray< FString > NewContainers,
FString NewMethod
)

 Sets the address to the given array of containers and provided method
Public function bool

SetMethod ( FString NewMethod
)

 Sets the method name of address

Operators

  Type Name Description
Public function Const FOSCAddress

operator/ ( const FOSCAddress& InAddress
)

  
Public function FOSCAddress &

operator/= ( const FOSCAddress& InAddress
)

  
Public function Const bool

operator== ( const FOSCAddress& InAddress
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page