1. Epic GamesDeveloper
  3. FBackChannelOSCMessage

FBackChannelOSCMessage

Representation of an OSC message.

API > API/Plugins > API/Plugins/BackChannel

Representation of an OSC message. Data can be read/written using the explicit Read/Write functions, or the Serialize function / << operator where the behaviour is overloaded based on whether the message was created for reading or writing.

Any failed Reads() will result in the default value of the type (e.g. 0, 0.0, false, "") being returned.

   
Name FBackChannelOSCMessage
Type class
Header File /Engine/Plugins/Experimental/BackChannel/Source/BackChannel/Public/BackChannel/Protocol/OSC/BackChannelOSCMessage.h
Include Path #include "BackChannel/Protocol/OSC/BackChannelOSCMessage.h"

Syntax

class FBackChannelOSCMessage :  
    public FBackChannelOSCPacket ,  
    public IBackChannelPacket

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers
Move constructor BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

FBackChannelOSCMessage ( const TCHAR* Address
)

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  
  BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FBackChannelOSCMessage()

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

Constants

Name Type Remarks Include Path
bIsLegacyConnection bool   BackChannel/Protocol/OSC/BackChannelOSCMessage.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 GetArgumentCount()

 Returns the number of arguments in this message BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

const int32 GetArgumentSize()

 Return the size (plus padding) of all our arguments) BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

TCHAR GetNextArgumentType()

 Returns the type of our next argument BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

const FString & GetTags()

 Return our argument tags BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

bool IsReading()

 Helper to check our read/write status BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

bool IsWriting()

 Helper to check our read/write status BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

int Read ( const TCHAR* InName,
TArray< T >& DataArray
)

 Read a TArray of type T from our arguments. BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

void ResetRead()

 Reset us for reading. The next argument read will be our first argument BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

void Serialize ( const TCHAR* Name,
T& Value
)

 Serialize helper that will read/write based on the open mode of this message BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

void Serialize ( const TCHAR* Name,
void* InBlob,
int32 BlobSize
)

 Serialize helper that will read/write based on the open mode of this message BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

int Write ( const TCHAR* InName,
const TArrayView< const T > InValues
)

 Write a TArrayView into the message BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

Overridden from FBackChannelOSCPacket

Name Remarks Include Path Unreal Specifiers

virtual int32 GetSize()

 Return our size (plus any necessary padding) BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual OSCPacketType GetType()

 Return our type BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual TArray< uint8 > WriteToBuffer ()

 Returns a buffer with the contents of this message. Data is padded per OSC requirements BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual void WriteToBuffer ( TArray< uint8 >& Buffer
) const

 Writes this message into the provided buffer at an offset of Buffer.Num() BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

Overridden from IBackChannelPacket

Name Remarks Include Path Unreal Specifiers

virtual FString GetPath()

 Returns the address of this packet BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual FBackChannelPacketType GetProtocolID()

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual FString GetProtocolName()

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual bool IsReadable()

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual bool IsWritable()

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual int Read ( const TCHAR* InName,
void* InBlob,
int32 MaxBlobSize,
int32& OutBlobSize
)

 Raw data blobs. BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual int Read ( const TCHAR* InName,
TArray< uint8 >& DataArray
)

 Read data from the message into a TArray. BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual int Read ( const TCHAR* InName,
FString& OutValue
)

 Read a string from our arguments. BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual int Read ( const TCHAR* InName,
bool& Value
)

 Read a bool from our arguments BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual int Read ( const TCHAR* InName,
float& OutValue
)

 Read a float from our arguments BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual int Read ( const TCHAR* InName,
int32& Value
)

 Read an int32 from our arguments BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual int SetPath ( const TCHAR* Address
)

 Set our destination address BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual int Write ( const TCHAR* InName,
const void* InBlob,
int32 BlobSize
)

 Write a blob of data to our arguments BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual int Write ( const TCHAR* InName,
const TCHAR* Value
)

 Write a string to our arguments BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual int Write ( const TCHAR* InName,
const int32 Value
)

 Int32 read/write. BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual int Write ( const TCHAR* InName,
const float Value
)

 Write a float to our arguments BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual int Write ( const TCHAR* InName,
const bool Value
)

 Write a bool to our arguments BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual int Write ( const TCHAR* InName,
const TArrayView< const uint8 > InValues
)

 Read data from the message into a TArray. BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

virtual int Write ( const TCHAR* InName,
const FString& Value
)

 Write a string to our arguments BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

Protected

Name Remarks Include Path Unreal Specifiers

void GetComponentSizes ( int32& OutAddressSize,
int32& OutTagSize,
int32& OutBufferSize
) const

 Return our sizes for each item (plus any necessary padding) BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

int ReadData ( void* InData,
int32 InSize
)

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

TCHAR ReadTag ( const TCHAR ExpectedTag,
bool SuppressWarning
)

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

int ReadTagAndData ( const TCHAR ExpectedTag,
void* InData,
int32 InSize
)

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

int Serialize ( const TCHAR Code,
void* InData,
int32 InSize
)

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

int WriteData ( const void* InData,
int32 InSize
)

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

int WriteTag ( const TCHAR Code
)

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

int WriteTagAndData ( const TCHAR Code,
const void* InData,
int32 InSize
)

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

Static

Name Remarks Include Path Unreal Specifiers

static TSharedPtr< FBackChannelOSCMessage > CreateFromBuffer ( const void* Data,
int32 DataLength
)

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

static bool IsLegacyConnection()

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

static int32 RoundedArgumentSize ( int32 ArgSize
)

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

static void SetLegacyMode ( const bool bEnable
)

   BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

Operators

Name Remarks Include Path Unreal Specifiers
Move operator BackChannel/Protocol/OSC/BackChannelOSCMessage.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page