UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::LiveLink::Compression Namespace Reference

Functions

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

Function Documentation

◆ GetCompressionAlgorithm() [1/2]

FName UE::LiveLink::Compression::GetCompressionAlgorithm ( )
inline

Get the named compression algorithm to invoke with serializer and memory compressors.

◆ GetCompressionAlgorithm() [2/2]

FName UE::LiveLink::Compression::GetCompressionAlgorithm ( ELiveLinkCompressionMethod  Method)
inline

Get the named compression algorithm based on the provided details. Current this is only Zlib or Oodle.

◆ GetCompressionBias()

ELiveLinkCompressionBias UE::LiveLink::Compression::GetCompressionBias ( ECompressionFlags  Flags)
inline

Get LiveLinkCompressionBias from a ECompressionFlags.

◆ GetCompressionFlags()

ECompressionFlags UE::LiveLink::Compression::GetCompressionFlags ( )
inline

Get the default flags to use when invoking the compressor.

◆ GetCompressionMethod()

ELiveLinkCompressionMethod UE::LiveLink::Compression::GetCompressionMethod ( FName  NamedMethod)
inline

Convert a compression method name to a ELiveLinkCompressionMethod.

◆ GetConsoleVariableCompressionFlags()

int32 UE::LiveLink::Compression::GetConsoleVariableCompressionFlags ( )

Function to check the console variable for the compression flags. Speed vs size.

◆ GetConsoleVariableCompressionType()

int32 UE::LiveLink::Compression::GetConsoleVariableCompressionType ( )

Get the compression type from the console variable setting.

◆ GetCoreCompressionFlags()

ECompressionFlags UE::LiveLink::Compression::GetCoreCompressionFlags ( ELiveLinkCompressionBias  InBias)
inline

Get the compression enum value given the LiveLink compression settings. This the value passed into the serializer and memory compressor.

◆ ShouldCompress()

template<typename SizeType >
bool UE::LiveLink::Compression::ShouldCompress ( SizeType  DataSize)
inline

Based on the size of the data to compress indicate if we should invoke the compressor.