FPlatformAudioCookOverrides

[FPlatformAudioCookOverrides](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.)

Choose your operating system:

Windows

macOS

Linux

References

Module

AudioPlatformConfiguration

Header

/Engine/Source/Runtime/AudioPlatformConfiguration/Public/AudioCompressionSettings.h

Include

#include "AudioCompressionSettings.h"

Syntax

struct FPlatformAudioCookOverrides

Remarks

FPlatformAudioCookOverrides This struct is used for settings used during the cook to a target platform (platform-specific compression quality and resampling, etc.)

Variables

Name Description

Public variable

float

 

AutoStreamingThreshold

When set to any platform > 0.0, this will automatically set any USoundWave beyond this value to be streamed from disk.

Public variable

bool

 

bInlineStreamedAudioChunks

Whether to put streamed audio chunks inline in the Pak file or not (only matters if bUseStreamCaching is true)

Public variable

bool

 

bResampleForDevice

Public variable

bool

 

bUseStreamCaching

Whether to use the experimental Load on Demand feature, which uses as little memory at runtime as possible.

Public variable

float

 

CompressionQualityModifier

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.

Public variable

TMap< ESoundwav...

 

PlatformSampleRates

Mapping of which sample rates are used for each sample rate quality for a specific platform.

Public variable

int32

 

SoundCueCookQualityIndex

If set, the cooker will keep only this level of quality.

Public variable

FAudioStreamCac...

 

StreamCachingSettings

If Load On Demand is enabled, these settings are used to determine chunks and cache sizes.

Constructors

Functions

Name Description

Public function Static

void

 

GetHashSuffix

(
    const FPlatformAudioCookOverrides&...,
    FString& OutSuffix
)

This is used to invalidate compressed audio for a specific platform.

Public function Static

int32

 

GetStreamCachingVersion()

Increment this return value to force a recook on all Stream Caching assets.