UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
LiveLinkCompression.h File Reference
#include "LiveLinkTypes.h"
#include "LiveLinkCompression.generated.h"

Go to the source code of this file.

Classes

struct  FLiveLinkByteArray
 
struct  TStructOpsTypeTraits< FLiveLinkByteArray >
 
struct  FLiveLinkSerializedFrameData
 

Namespaces

namespace  UE
 
 
 

Macros

#define UE_API   LIVELINKMESSAGEBUSFRAMEWORK_API
 

Enumerations

enum class  ELiveLinkCompressionMethod : uint8 { Uncompressed , Oodle , Zlib }
 
enum class  ELiveLinkCompressionBias : uint8 { None , Size , Speed }
 
enum class  ELiveLinkPayloadSerializationMethod : uint8 { Standard = 0 , Cbor }
 
enum class  ELiveLinkPayloadCompressionType : uint8 { None = 0 , Heuristic , Always }
 

Functions

int32 UE::LiveLink::Compression::GetConsoleVariableCompressionType ()
 
int32 UE::LiveLink::Compression::GetConsoleVariableCompressionFlags ()
 
template<typename SizeType >
bool UE::LiveLink::Compression::ShouldCompress (SizeType DataSize)
 
FName UE::LiveLink::Compression::GetCompressionAlgorithm ()
 
ECompressionFlags UE::LiveLink::Compression::GetCompressionFlags ()
 
FName UE::LiveLink::Compression::GetCompressionAlgorithm (ELiveLinkCompressionMethod Method)
 
ECompressionFlags UE::LiveLink::Compression::GetCoreCompressionFlags (ELiveLinkCompressionBias InBias)
 
ELiveLinkCompressionBias UE::LiveLink::Compression::GetCompressionBias (ECompressionFlags Flags)
 
ELiveLinkCompressionMethod UE::LiveLink::Compression::GetCompressionMethod (FName NamedMethod)
 

Macro Definition Documentation

◆ UE_API

Enumeration Type Documentation

◆ ELiveLinkCompressionBias

The bias (if any) to use when compressing the data.

Enumerator
None 

Compress without a bias.

Size 

Compress with a bias for size

Speed 

Compress with a bias for speed.

◆ ELiveLinkCompressionMethod

What compression method should be used on the LiveLink data.

Enumerator
Uncompressed 

Data is uncompressed.

Oodle 

Oodle compression is used for the serialized data.

Zlib 

ZLib compression is used for the serialized data.

◆ ELiveLinkPayloadCompressionType

Dictates when compression should be used.

Enumerator
None 
Heuristic 
Always 

◆ ELiveLinkPayloadSerializationMethod

What method should be used for serialziing.

Enumerator
Standard 
Cbor