1. Epic GamesDeveloper
  3. FOSCAddress

FOSCAddress

API > API/Plugins > API/Plugins/OSC

   
Name FOSCAddress
Type struct
Header File /Engine/Plugins/Runtime/OSC/Source/OSC/Public/OSCAddress.h
Include Path #include "OSCAddress.h"

Syntax

USTRUCT (BlueprintType )  
struct FOSCAddress

Constructors

Name Remarks Include Path Unreal Specifiers

FOSCAddress ( const FString& InValue
)

   OSCAddress.h  
  OSCAddress.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsValidPath bool   OSCAddress.h  
bIsValidPattern bool Cached values for validity and hash OSCAddress.h  
Containers TArray< FString > Ordered array of container names. OSCAddress.h  
Hash uint32   OSCAddress.h  
Method FString Method name of string. OSCAddress.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearContainers()

 Clears ordered array of containers OSCAddress.h  

FString GetContainer ( int32 Index
) const

 Returns container at provided Index. If Index is out-of-bounds, returns empty string. OSCAddress.h  

FString GetContainerPath()

 Returns container path of OSC address in the form '/Container1/Container2' OSCAddress.h  

void GetContainers ( TArray< FString >& OutContainers
) const

 Builds referenced array of address of containers in order OSCAddress.h  

FString GetFullPath()

 Returns full path of OSC address in the form '/Container1/Container2/Method' OSCAddress.h  

const FString & GetMethod()

 Get method name of address OSCAddress.h  

bool GetNumericPrefix ( int32& OutPrefix
) const

 Returns numeric prefix of OSC method if is numeric OSCAddress.h  

bool GetNumericSuffix ( int32& OutSuffix
) const

 Returns numeric suffix of OSC method if is numeric OSCAddress.h  

bool IsValidPath()

 Returns whether address is valid path OSCAddress.h  

bool IsValidPattern()

 Returns whether address is valid pattern OSCAddress.h  

bool Matches ( const FOSCAddress& InAddress
) const

 Returns if this address is a pattern that matches InAddress' path. OSCAddress.h  
Pops container from ordered array of containers OSCAddress.h  

bool PopContainer ( FString& OutContainer
)

 Pops container from ordered array of containers OSCAddress.h  

TArray< FString > PopContainers ( int32 NumToPop
)

 Pops containers off end of address' ordered array of containers OSCAddress.h  

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

 Pops containers off end of address' ordered array of containers OSCAddress.h  

bool PushContainer ( FString Container
)

 Pushes container onto end of address' ordered array of containers OSCAddress.h  

bool PushContainers ( TArray< FString > NewContainers
)

 Pushes containers onto end of address' ordered array of containers OSCAddress.h  

bool RemoveContainers ( int32 InIndex,
int32 InCount
)

 Removes containers from container array at index until count OSCAddress.h  

bool Set ( TArray< FString > NewContainers,
FString NewMethod
)

 Sets the address to the given array of containers and provided method OSCAddress.h  

bool SetMethod ( FString NewMethod
)

 Sets the method name of address OSCAddress.h  

Operators

Name Remarks Include Path Unreal Specifiers

FOSCAddress operator/ ( const FOSCAddress& InAddress
) const

   OSCAddress.h  

FOSCAddress & operator/= ( const FOSCAddress& InAddress
)

   OSCAddress.h  

bool operator== ( const FOSCAddress& InAddress
) const

   OSCAddress.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page