FLiveLinkSerializedFrameData Struct Reference

#include <LiveLinkCompression.h>

Public Member Functions
	FLiveLinkSerializedFrameData ()=default
	FLiveLinkSerializedFrameData (ELiveLinkPayloadSerializationMethod SerializeMethod)
UE_API bool	SetPayload (const FStructOnScope &InPayload, ELiveLinkPayloadCompressionType CompressionType=ELiveLinkPayloadCompressionType::Heuristic)
UE_API bool	SetPayload (const UScriptStruct *InPayloadType, const void *InPayloadData, ELiveLinkPayloadCompressionType CompressionType=ELiveLinkPayloadCompressionType::Heuristic)
template<typename T >
bool	SetTypedPayload (const T &InPayloadData, ELiveLinkPayloadCompressionType CompressType=ELiveLinkPayloadCompressionType::Heuristic)
UE_API bool	GetPayload (FStructOnScope &OutPayload) const
UE_API bool	GetPayload (const UScriptStruct *InPayloadType, void *InOutPayloadData) const
UE_API bool	IsTypeChildOf (const UScriptStruct *InPayloadType) const
template<typename T >
bool	IsTypeChildOf () const
template<typename T >
bool	GetTypedPayload (T &OutPayloadData) const

Public Attributes
FName	PayloadTypeName
ELiveLinkPayloadSerializationMethod	SerializationMethod = ELiveLinkPayloadSerializationMethod::Standard
ELiveLinkCompressionMethod	CompressionMethod = ELiveLinkCompressionMethod::Uncompressed
ELiveLinkCompressionBias	CompressionBias = ELiveLinkCompressionBias::None
int32	PayloadSize = 0
FLiveLinkByteArray	PayloadBytes

Detailed Description

Utility struct used to wrap serialized data and handle compression / decompression.

Constructor & Destructor Documentation

FLiveLinkSerializedFrameData() [1/2]

FLiveLinkSerializedFrameData::FLiveLinkSerializedFrameData ( )

default

FLiveLinkSerializedFrameData() [2/2]

FLiveLinkSerializedFrameData::FLiveLinkSerializedFrameData ( ELiveLinkPayloadSerializationMethod  SerializeMethod )

inline

Member Function Documentation

GetPayload() [1/2]

bool FLiveLinkSerializedFrameData::GetPayload	(	const UScriptStruct *	InPayloadType,
		void *	InOutPayloadData
	)		const

GetPayload() [2/2]

bool FLiveLinkSerializedFrameData::GetPayload

(

FStructOnScope &

OutPayload

)

const

Extract the payload into an in-memory instance

GetTypedPayload()

template<typename T >

bool FLiveLinkSerializedFrameData::GetTypedPayload ( T &  OutPayloadData ) const

inline

IsTypeChildOf() [1/2]

template<typename T >

bool FLiveLinkSerializedFrameData::IsTypeChildOf ( ) const

inline

IsTypeChildOf() [2/2]

bool FLiveLinkSerializedFrameData::IsTypeChildOf

(

const UScriptStruct *

InPayloadType

)

const

SetPayload() [1/2]

bool FLiveLinkSerializedFrameData::SetPayload	(	const FStructOnScope &	InPayload,
		ELiveLinkPayloadCompressionType	CompressionType = ELiveLinkPayloadCompressionType::Heuristic
	)

Initialize this payload from the given data

SetPayload() [2/2]

bool FLiveLinkSerializedFrameData::SetPayload	(	const UScriptStruct *	InPayloadType,
		const void *	InPayloadData,
		ELiveLinkPayloadCompressionType	CompressionType = ELiveLinkPayloadCompressionType::Heuristic
	)

SetTypedPayload()

template<typename T >

bool FLiveLinkSerializedFrameData::SetTypedPayload ( const T &  InPayloadData, ELiveLinkPayloadCompressionType  CompressType = ELiveLinkPayloadCompressionType::Heuristic  )

inline

Member Data Documentation

CompressionBias

ELiveLinkCompressionBias FLiveLinkSerializedFrameData::CompressionBias = ELiveLinkCompressionBias::None

CompressionMethod

ELiveLinkCompressionMethod FLiveLinkSerializedFrameData::CompressionMethod = ELiveLinkCompressionMethod::Uncompressed

PayloadBytes

FLiveLinkByteArray FLiveLinkSerializedFrameData::PayloadBytes

The data of the user-defined payload (potentially stored as compressed binary for compact transfer).

PayloadSize

int32 FLiveLinkSerializedFrameData::PayloadSize = 0

The uncompressed size of the user-defined payload data.

PayloadTypeName

FName FLiveLinkSerializedFrameData::PayloadTypeName

The typename of the user-defined payload.

SerializationMethod

ELiveLinkPayloadSerializationMethod FLiveLinkSerializedFrameData::SerializationMethod = ELiveLinkPayloadSerializationMethod::Standard

Specifies the serialization method used to pack the data

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/LiveLinkMessageBusFramework/Public/LiveLinkCompression.h
• Engine/Source/Runtime/LiveLinkMessageBusFramework/Private/LiveLinkCompression.cpp