Navigation
API > API/Runtime > API/Runtime/AudioPlatformConfiguration
FPlatformAudioCookOverrides This struct is used for settings used during the cook to a target platform (platform-specific compression quality and resampling, etc.)
| Name | FPlatformAudioCookOverrides |
| Type | struct |
| Header File | /Engine/Source/Runtime/AudioPlatformConfiguration/Public/AudioCompressionSettings.h |
| Include Path | #include "AudioCompressionSettings.h" |
Syntax
struct FPlatformAudioCookOverrides
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPlatformAudioCookOverrides() |
AudioCompressionSettings.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AutoStreamingThreshold | float | When set to any platform > 0.0, this will automatically set any USoundWave beyond this value to be streamed from disk. | AudioCompressionSettings.h | |
| bInlineFirstAudioChunk | bool | Wether to inline the first "Audio" chunk, which is typically chunk 1. (Only on assets marked retain-on-load with a size of audio in secs set) | AudioCompressionSettings.h | |
| bResampleForDevice | bool | AudioCompressionSettings.h | ||
| CompressionQualityModifier | float | Scales all compression qualities when cooking to this platform. For example, 0.5 will halve all compression qualities, and 1.0 will leave them unchanged. | AudioCompressionSettings.h | |
| LengthOfFirstAudioChunkInSecs | float | This will decide how much data to put in the first audio chunk. | AudioCompressionSettings.h | |
| PlatformSampleRates | TMap< ESoundwaveSampleRateSettings, float > | Mapping of which sample rates are used for each sample rate quality for a specific platform. | AudioCompressionSettings.h | |
| SoundCueCookQualityIndex | int32 | If set, the cooker will keep only this level of quality. | AudioCompressionSettings.h | |
| StreamCachingSettings | FAudioStreamCachingSettings | If Load On Demand is enabled, these settings are used to determine chunks and cache sizes. | AudioCompressionSettings.h |
Functions
Public
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void GetHashSuffix
(
const FPlatformAudioCookOverrides* InOverrides, |
This is used to invalidate compressed audio for a specific platform. | AudioCompressionSettings.h | |
static int32 GetStreamCachingVersion () |
Increment this return value to force a recook on all Stream Caching assets. | AudioCompressionSettings.h |