UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FAudioCookOutputs Struct Reference

#include <AudioDerivedData.h>

Public Member Functions

bool Serialize (FArchive &Ar)
 

Static Public Member Functions

static uint32 GetId ()
 
static int32 GetVersion ()
 

Public Attributes

uint32 Id = GetId()
 
int32 Version = GetVersion()
 
int32 NumChannels = 0
 
int32 SampleRate = 0
 
uint32 NumFrames = 0
 
TArray< uint8EncodedData
 

Detailed Description

Struct that's serialized into the DDC record for "Audio" DDC task. Filled in by the encoders, additional relevant state is passed back here. Like decisions make during encoding, like resampling, transformations etc.

Member Function Documentation

◆ GetId()

static uint32 FAudioCookOutputs::GetId ( )
inlinestatic

Get the expected ID of this struct. uint32 so we can peek at memory.

Returns
uint32 Id.

◆ GetVersion()

int32 FAudioCookOutputs::GetVersion ( )
static

Gets the current Version expected. Any other versions would be an error.

Returns
int32 Version.

◆ Serialize()

bool FAudioCookOutputs::Serialize ( FArchive Ar)

Serializer (read/write)

Parameters
ArReader/Writer Archive.
Returns
True if successfully read/written, false otherwise.

Member Data Documentation

◆ EncodedData

TArray<uint8> FAudioCookOutputs::EncodedData

The Binary output of the IAudioFormat.

◆ Id

uint32 FAudioCookOutputs::Id = GetId()

◆ NumChannels

int32 FAudioCookOutputs::NumChannels = 0

Final channel count that was encoded by the IAudioFormat

◆ NumFrames

uint32 FAudioCookOutputs::NumFrames = 0

Number of frames in the encoded data.

◆ SampleRate

int32 FAudioCookOutputs::SampleRate = 0

Final Sample rate that was encoded by IAudioFormat

◆ Version

int32 FAudioCookOutputs::Version = GetVersion()

The documentation for this struct was generated from the following files: