UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
SoundSubmix.h File Reference
#include "CoreMinimal.h"
#include "AudioDeviceHandle.h"
#include "AudioLinkSettingsAbstract.h"
#include "DSP/SpectrumAnalyzer.h"
#include "IAudioEndpoint.h"
#include "ISoundfieldEndpoint.h"
#include "ISoundfieldFormat.h"
#include "SampleBufferIO.h"
#include "SoundEffectSubmix.h"
#include "SoundModulationDestination.h"
#include "SoundSubmixSend.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "SoundSubmix.generated.h"

Go to the source code of this file.

Classes

struct  FSoundSpectrumAnalyzerSettings
 
struct  FSoundSpectrumAnalyzerDelegateSettings
 
struct  FDynamicChildSubmix
 
class  USoundSubmixBase
 
class  USoundSubmixWithParentBase
 
class  USoundSubmix
 
class  USoundfieldSubmix
 
class  UEndpointSubmix
 
class  USoundfieldEndpointSubmix
 

Namespaces

namespace  SubmixUtils
 

Enumerations

enum class  EFFTSize : uint8 {
  DefaultSize , Min , Small , Medium ,
  Large , VeryLarge , Max
}
 
enum class  EFFTPeakInterpolationMethod : uint8 { NearestNeighbor , Linear , Quadratic , ConstantQ }
 
enum class  EFFTWindowType : uint8 { None , Hamming , Hann , Blackman }
 
enum class  EAudioSpectrumType : uint8 { MagnitudeSpectrum , PowerSpectrum , Decibel }
 
enum class  EGainParamMode : uint8 { Linear = 0 , Decibels }
 

Functions

 DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FOnSubmixRecordedFileDone, const USoundWave *, ResultingSoundWave)
 
 DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FOnSubmixEnvelope, const TArray< float > &, Envelope)
 
 DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FOnSubmixSpectralAnalysis, const TArray< float > &, Magnitudes)
 
ENGINE_API void SubmixUtils::ForEachStaticChildRecursive (USoundSubmixBase *StartingPoint, const TFunction< void(USoundSubmixBase *)> &Op)
 
ENGINE_API bool SubmixUtils::AreSubmixFormatsCompatible (const USoundSubmixBase *ChildSubmix, const USoundSubmixBase *ParentSubmix)
 
ENGINE_API bool SubmixUtils::FindInGraph (const USoundSubmixBase *InEntryPoint, const USoundSubmixBase *InToMatch, bool bShouldAcsend, FAudioDeviceHandle InDevice={})
 
ENGINE_API const USoundSubmixBaseSubmixUtils::FindRoot (const USoundSubmixBase *InStartingPoint, FAudioDeviceHandle InDevice)
 

Enumeration Type Documentation

◆ EAudioSpectrumType

enum class EAudioSpectrumType : uint8
strong
Enumerator
MagnitudeSpectrum 
PowerSpectrum 
Decibel 

◆ EFFTPeakInterpolationMethod

Enumerator
NearestNeighbor 
Linear 
Quadratic 
ConstantQ 

◆ EFFTSize

enum class EFFTSize : uint8
strong
Enumerator
DefaultSize 
Min 
Small 
Medium 
Large 
VeryLarge 
Max 

◆ EFFTWindowType

enum class EFFTWindowType : uint8
strong
Enumerator
None 
Hamming 
Hann 
Blackman 

◆ EGainParamMode

enum class EGainParamMode : uint8
strong
Enumerator
Linear 
Decibels 

Function Documentation

◆ DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam() [1/3]

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam ( FOnSubmixEnvelope  ,
const TArray< float > &  ,
Envelope   
)

Called when a new submix envelope value is generated on the given audio device id (different for multiple PIE). Array is an envelope value for each channel.

◆ DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam() [2/3]

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam ( FOnSubmixRecordedFileDone  ,
const USoundWave ,
ResultingSoundWave   
)

Called when a recorded file has finished writing to disk.

◆ DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam() [3/3]

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam ( FOnSubmixSpectralAnalysis  ,
const TArray< float > &  ,
Magnitudes   
)