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

#include <SoundEffectSubmix.h>

Public Member Functions

 FSoundEffectSubmixInputData ()
 

Public Attributes

voidPresetData
 
int32 NumFrames
 
int32 NumChannels
 
int32 NumDeviceChannels
 
const TArray< FTransform > * ListenerTransforms
 
Audio::FAlignedFloatBufferAudioBuffer
 
double AudioClock
 

Detailed Description

Struct which supplies audio data to submix effects on game thread.

Constructor & Destructor Documentation

◆ FSoundEffectSubmixInputData()

FSoundEffectSubmixInputData::FSoundEffectSubmixInputData ( )
inline

Member Data Documentation

◆ AudioBuffer

Audio::FAlignedFloatBuffer* FSoundEffectSubmixInputData::AudioBuffer

The raw input audio buffer. Size is NumFrames * NumChannels

◆ AudioClock

double FSoundEffectSubmixInputData::AudioClock

Sample accurate audio clock.

◆ ListenerTransforms

const TArray<FTransform>* FSoundEffectSubmixInputData::ListenerTransforms

The listener transforms (one for each viewport index).

◆ NumChannels

int32 FSoundEffectSubmixInputData::NumChannels

The number of channels of the submix.

◆ NumDeviceChannels

int32 FSoundEffectSubmixInputData::NumDeviceChannels

The number of device channels.

◆ NumFrames

int32 FSoundEffectSubmixInputData::NumFrames

The number of audio frames for this input data. 1 frame is an interleaved sample.

◆ PresetData

void* FSoundEffectSubmixInputData::PresetData

Ptr to preset data if new data is available. This will be nullptr if no new preset data has been set.


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