UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
AudioCompressionSettingsUtils.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
6
8
10{
11public:
12 // Returns the Duration Threshold for the current platform if it is overridden, -1.0f otherwise.
14
15 // Returns the sample rate for a given platform,
17
19
21
22 static ENGINE_API void RecacheCookOverrides();
23
24 // null platformname means to use current platform
25 static ENGINE_API const FPlatformAudioCookOverrides* GetCookOverrides(const TCHAR* PlatformName=nullptr, bool bForceRecache = false);
26
27 UE_DEPRECATED(5.5, "this always returns true, no longer needed.")
29
30 // null platformname means to use current platform
32
35
38
39 template<typename HashType>
40 static void AppendHash(FString& OutString, const TCHAR* InName, const HashType& InValueToHash)
41 {
42 OutString += FString::Printf(TEXT("%s_%s_"), InName, ToCStr(LexToString(InValueToHash)));
43 }
44
45private:
46 static ENGINE_API const FPlatformRuntimeAudioCompressionOverrides* GetRuntimeCompressionOverridesForCurrentPlatform();
47
48};
ESoundwaveSampleRateSettings
Definition AudioCompressionSettings.h:15
#define UE_DEPRECATED(Version, Message)
Definition CoreMiscDefines.h:302
#define TEXT(x)
Definition Platform.h:1272
FPlatformTypes::TCHAR TCHAR
Either ANSICHAR or WIDECHAR, depending on whether the platform supports wide characters or the requir...
Definition Platform.h:1135
FPlatformTypes::int32 int32
A 32-bit signed integer.
Definition Platform.h:1125
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
const TCHAR * LexToString(EAnalyticsRecordEventMode Mode)
Definition IAnalyticsProvider.cpp:5
UE_FORCEINLINE_HINT const UE_STRING_CLASS::ElementType * ToCStr(const UE_STRING_CLASS &Str)
Definition UnrealString.h.inl:2326
uint32_t uint32
Definition binka_ue_file_header.h:6
Definition AudioCompressionSettingsUtils.h:10
static ENGINE_API int32 GetMaxPreloadedBranchesForCurrentPlatform()
Definition AudioCompressionSettingsUtils.cpp:418
static ENGINE_API void RecacheCookOverrides()
Definition AudioCompressionSettingsUtils.cpp:282
static ENGINE_API float GetTargetSampleRateForPlatform(ESoundwaveSampleRateSettings InSampleRateLevel=ESoundwaveSampleRateSettings::High)
Definition AudioCompressionSettingsUtils.cpp:397
static ENGINE_API uint32 GetMaxChunkSizeForCookOverrides(const FPlatformAudioCookOverrides *InCompressionOverrides)
Definition AudioCompressionSettingsUtils.cpp:362
static void AppendHash(FString &OutString, const TCHAR *InName, const HashType &InValueToHash)
Definition AudioCompressionSettingsUtils.h:40
static ENGINE_API const FPlatformAudioCookOverrides * GetCookOverrides(const TCHAR *PlatformName=nullptr, bool bForceRecache=false)
Definition AudioCompressionSettingsUtils.cpp:292
static ENGINE_API int32 GetQualityIndexOverrideForCurrentPlatform()
Definition AudioCompressionSettingsUtils.cpp:432
static ENGINE_API FCachedAudioStreamingManagerParams BuildCachedStreamingManagerParams()
Definition AudioCompressionSettingsUtils.cpp:330
static ENGINE_API float GetCompressionDurationForCurrentPlatform()
Definition AudioCompressionSettingsUtils.cpp:384
static bool IsCurrentPlatformUsingStreamCaching()
Definition AudioCompressionSettingsUtils.h:28
static ENGINE_API const FAudioStreamCachingSettings & GetStreamCachingSettingsForCurrentPlatform()
Definition AudioCompressionSettingsUtils.cpp:323
Definition AudioCompressionSettings.h:29
Definition AudioStreamingCache.h:489
Definition AudioCompressionSettings.h:61
Definition AudioCompressionSettings.h:113