Navigation
API > API/Runtime > API/Runtime/LiveLinkMessageBusFramework
Utility struct used to wrap serialized data and handle compression / decompression.
| Name | FLiveLinkSerializedFrameData |
| Type | struct |
| Header File | /Engine/Source/Runtime/LiveLinkMessageBusFramework/Public/LiveLinkCompression.h |
| Include Path | #include "LiveLinkCompression.h" |
Syntax
USTRUCT ()
struct FLiveLinkSerializedFrameData
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| LiveLinkCompression.h | |||
FLiveLinkSerializedFrameData
(
ELiveLinkPayloadSerializationMethod SerializeMethod |
LiveLinkCompression.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CompressionBias | ELiveLinkCompressionBias | LiveLinkCompression.h |
|
|
| CompressionMethod | ELiveLinkCompressionMethod | LiveLinkCompression.h |
|
|
| PayloadBytes | FLiveLinkByteArray | The data of the user-defined payload (potentially stored as compressed binary for compact transfer). | LiveLinkCompression.h | |
| PayloadSize | int32 | The uncompressed size of the user-defined payload data. | LiveLinkCompression.h |
|
| PayloadTypeName | FName | The typename of the user-defined payload. | LiveLinkCompression.h |
|
| SerializationMethod | ELiveLinkPayloadSerializationMethod | Specifies the serialization method used to pack the data | LiveLinkCompression.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetPayload
(
FStructOnScope& OutPayload |
Extract the payload into an in-memory instance | LiveLinkCompression.h | |
bool GetPayload
(
const UScriptStruct* InPayloadType, |
LiveLinkCompression.h | ||
bool GetTypedPayload
(
T& OutPayloadData |
LiveLinkCompression.h | ||
bool IsTypeChildOf () |
LiveLinkCompression.h | ||
bool IsTypeChildOf
(
const UScriptStruct* InPayloadType |
LiveLinkCompression.h | ||
bool SetPayload
(
const FStructOnScope& InPayload, |
Initialize this payload from the given data | LiveLinkCompression.h | |
bool SetPayload
(
const UScriptStruct* InPayloadType, |
LiveLinkCompression.h | ||
bool SetTypedPayload
(
const T& InPayloadData, |
LiveLinkCompression.h |