UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Static Public Member Functions | List of all members
FPlatformCompressionUtilities Class Reference

#include <AudioCompressionSettingsUtils.h>

Static Public Member Functions

static ENGINE_API float GetCompressionDurationForCurrentPlatform ()
 
static ENGINE_API float GetTargetSampleRateForPlatform (ESoundwaveSampleRateSettings InSampleRateLevel=ESoundwaveSampleRateSettings::High)
 
static ENGINE_API int32 GetMaxPreloadedBranchesForCurrentPlatform ()
 
static ENGINE_API int32 GetQualityIndexOverrideForCurrentPlatform ()
 
static ENGINE_API void RecacheCookOverrides ()
 
static ENGINE_API const FPlatformAudioCookOverrides * GetCookOverrides (const TCHAR *PlatformName=nullptr, bool bForceRecache=false)
 
static bool IsCurrentPlatformUsingStreamCaching ()
 
static ENGINE_API const FAudioStreamCachingSettings & GetStreamCachingSettingsForCurrentPlatform ()
 
static ENGINE_API FCachedAudioStreamingManagerParams BuildCachedStreamingManagerParams ()
 
static ENGINE_API uint32 GetMaxChunkSizeForCookOverrides (const FPlatformAudioCookOverrides *InCompressionOverrides)
 
template<typename HashType >
static void AppendHash (FString &OutString, const TCHAR *InName, const HashType &InValueToHash)
 

Member Function Documentation

◆ AppendHash()

template<typename HashType >
static void FPlatformCompressionUtilities::AppendHash ( FString &  OutString,
const TCHAR *  InName,
const HashType &  InValueToHash 
)
inlinestatic

◆ BuildCachedStreamingManagerParams()

FCachedAudioStreamingManagerParams FPlatformCompressionUtilities::BuildCachedStreamingManagerParams ( )
static

This is used at runtime to initialize FCachedAudioStreamingManager.

◆ GetCompressionDurationForCurrentPlatform()

float FPlatformCompressionUtilities::GetCompressionDurationForCurrentPlatform ( )
static

◆ GetCookOverrides()

const FPlatformAudioCookOverrides * FPlatformCompressionUtilities::GetCookOverrides ( const TCHAR *  PlatformName = nullptr,
bool  bForceRecache = false 
)
static

◆ GetMaxChunkSizeForCookOverrides()

uint32 FPlatformCompressionUtilities::GetMaxChunkSizeForCookOverrides ( const FPlatformAudioCookOverrides *  InCompressionOverrides)
static

This is used at runtime in BuildCachedStreamingManagerParams, as well as cooktime in FStreamedAudioCacheDerivedDataWorker::BuildStreamedAudio to split compressed audio.

◆ GetMaxPreloadedBranchesForCurrentPlatform()

int32 FPlatformCompressionUtilities::GetMaxPreloadedBranchesForCurrentPlatform ( )
static

◆ GetQualityIndexOverrideForCurrentPlatform()

int32 FPlatformCompressionUtilities::GetQualityIndexOverrideForCurrentPlatform ( )
static

◆ GetStreamCachingSettingsForCurrentPlatform()

const FAudioStreamCachingSettings & FPlatformCompressionUtilities::GetStreamCachingSettingsForCurrentPlatform ( )
static

◆ GetTargetSampleRateForPlatform()

float FPlatformCompressionUtilities::GetTargetSampleRateForPlatform ( ESoundwaveSampleRateSettings  InSampleRateLevel = ESoundwaveSampleRateSettings::High)
static

◆ IsCurrentPlatformUsingStreamCaching()

static bool FPlatformCompressionUtilities::IsCurrentPlatformUsingStreamCaching ( )
inlinestatic

◆ RecacheCookOverrides()

void FPlatformCompressionUtilities::RecacheCookOverrides ( )
static
The documentation for this class was generated from the following files: