1. Epic GamesDeveloper
  3. USoundSubmix

USoundSubmix

Sound Submix class meant for applying an effect to the downmixed sum of multiple audio sources.

API > API/Runtime > API/Runtime/Engine

Sound Submix class meant for applying an effect to the downmixed sum of multiple audio sources.

   
Name USoundSubmix
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Sound/SoundSubmix.h
Include Path #include "Sound/SoundSubmix.h"

Syntax

UCLASS (Config=Engine, HideCategories=Object, EditInlineNew, BlueprintType, MinimalAPI)  
class USoundSubmix : public USoundSubmixWithParentBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

USoundSubmix ( const FObjectInitializer& ObjectInitializer
)

   Sound/SoundSubmix.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AmbisonicsPluginSettings TObjectPtr< USoundfieldEncodingSettingsBase > Optional settings used by plugins which support ambisonics file playback. Sound/SoundSubmix.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=SoundSubmix
AudioLinkSettings TObjectPtr< UAudioLinkSettingsAbstract > Optional Audio Link Settings Object Sound/SoundSubmix.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AudioLink
bMuteWhenBackgrounded uint8 Mute this submix when the application is muted or in the background. Sound/SoundSubmix.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=SoundSubmix
bSendToAudioLink uint8 Whether to send this Submix to AudioLink (when AudioLink is Enabled) Sound/SoundSubmix.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AudioLink
DryLevelModulation FSoundModulationDestinationSettings The dry level of the submix in Decibels. Applied before submix effects and analysis are performed. Sound/SoundSubmix.h
  • EditAnywhere
  • BlueprintSetter=SetDryVolumeModulation
  • Category=SubmixLevel
  • Meta=(DisplayName="Dry Level (dB)", AudioParam="Volume", AudioParamClass="SoundModulationParameterVolume", ClampMin="-96.0", ClampMax="0.0", UIMin="-96.0", UIMax="0.0")
EnvelopeFollowerAttackTime int32 The attack time in milliseconds for the envelope follower. Sound/SoundSubmix.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=EnvelopeFollower
  • Meta=(ClampMin="0", UIMin="0")
EnvelopeFollowerReleaseTime int32 The release time in milliseconds for the envelope follower. Sound/SoundSubmix.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=EnvelopeFollower
  • Meta=(ClampMin="0", UIMin="0")
OnSubmixRecordedFileDone FOnSubmixRecordedFileDone Blueprint delegate for when a recorded file is finished exporting. Sound/SoundSubmix.h
  • BlueprintAssignable
OutputVolumeModulation FSoundModulationDestinationSettings The output volume of the submix in Decibels. Sound/SoundSubmix.h
  • EditAnywhere
  • BlueprintSetter=SetOutputVolumeModulation
  • Category=SubmixLevel
  • Meta=(DisplayName="Output Volume (dB)", AudioParam="Volume", AudioParamClass="SoundModulationParameterVolume", ClampMin="-96.0", ClampMax="0.0", UIMin="-96.0", UIMax="0.0")
SubmixEffectChain TArray< TObjectPtr< USoundEffectSubmixPreset > >   Sound/SoundSubmix.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=SoundSubmix
WetLevelModulation FSoundModulationDestinationSettings The wet level of the submixin Decibels. Applied after submix effects and analysis are performed. Sound/SoundSubmix.h
  • EditAnywhere
  • BlueprintSetter=SetWetVolumeModulation
  • Category=SubmixLevel
  • Meta=(DisplayName="Wet Level (dB)", AudioParam="Volume", AudioParamClass="SoundModulationParameterVolume", ClampMin="-96.0", ClampMax="0.0", UIMin="-96.0", UIMax="0.0")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddEnvelopeFollowerDelegate ( const UObject* WorldContextObject,
const FOnSubmixEnvelopeBP& OnSubmixEnvelopeBP
)

 Adds an envelope follower delegate to the submix when envelope following is enabled on this submix. Sound/SoundSubmix.h
  • BlueprintCallable
  • Category="Audio|EnvelopeFollowing"
  • Meta=(WorldContext="WorldContextObject")

void AddSpectralAnalysisDelegate ( const UObject* WorldContextObject,
const TArray< FSoundSubmixSpectralAnalysisBandSettings >& InBandSettings,
const FOnSubmixSpectralAnalysisBP& OnSubmixSpectralAnalysisBP,
float UpdateRate,
float DecibelNoiseFloor,
bool bDoNormalize,
bool bDoAutoRange,
float AutoRangeAttackTime,
float AutoRangeReleaseTime
)

 Adds a spectral analysis delegate to receive notifications when this submix has spectrum analysis enabled. Sound/SoundSubmix.h
  • BlueprintCallable
  • Category="Audio|Spectrum"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay=3)

void RemoveEnvelopeFollowerDelegate ( const UObject* WorldContextObject,
const FOnSubmixEnvelopeBP& OnSubmixEnvelopeBP
)

 Remove an envelope follower delegate. Sound/SoundSubmix.h
  • BlueprintCallable
  • Category="Audio|EnvelopeFollowing"
  • Meta=(WorldContext="WorldContextObject")

void RemoveSpectralAnalysisDelegate ( const UObject* WorldContextObject,
const FOnSubmixSpectralAnalysisBP& OnSubmixSpectralAnalysisBP
)

 Remove a spectral analysis delegate. Sound/SoundSubmix.h
  • BlueprintCallable
  • Category="Audio|Spectrum"
  • Meta=(WorldContext="WorldContextObject")

void SetSubmixDryLevel ( const UObject* WorldContextObject,
float InDryLevel
)

 Sets the output volume of the submix in linear gain. Sound/SoundSubmix.h
  • BlueprintCallable
  • Category="Audio"
  • Meta=(WorldContext="WorldContextObject", DisplayName="SetSubmixDryLevel (linear gain)")

void SetSubmixOutputVolume ( const UObject* WorldContextObject,
float InOutputVolume
)

 Sets the output volume of the submix in linear gain. Sound/SoundSubmix.h
  • BlueprintCallable
  • Category="Audio"
  • Meta=(WorldContext="WorldContextObject", DisplayName="SetSubmixOutputVolume (linear gain)")

void SetSubmixWetLevel ( const UObject* WorldContextObject,
float InWetLevel
)

 Sets the output volume of the submix in linear gain. Sound/SoundSubmix.h
  • BlueprintCallable
  • Category="Audio"
  • Meta=(WorldContext="WorldContextObject", DisplayName="SetSubmixWetLevel (linear gain)")

void StartEnvelopeFollowing ( const UObject* WorldContextObject
)

 Start envelope following the submix output. Register with OnSubmixEnvelope to receive envelope follower data in BP. Sound/SoundSubmix.h
  • BlueprintCallable
  • Category="Audio|EnvelopeFollowing"
  • Meta=(WorldContext="WorldContextObject")
  Sound/SoundSubmix.h  

void StartRecordingOutput ( const UObject* WorldContextObject,
float ExpectedDuration
)

 Start recording the audio from this submix. Sound/SoundSubmix.h
  • BlueprintCallable
  • Category="Audio|Bounce"
  • Meta=(WorldContext="WorldContextObject", DisplayName="Start Recording Submix Output")

void StartRecordingOutput ( FAudioDevice* InDevice,
float ExpectedDuration
)

   Sound/SoundSubmix.h  

void StartSpectralAnalysis ( const UObject* WorldContextObject,
EFFTSize FFTSize,
EFFTPeakInterpolationMethod InterpolationMethod,
EFFTWindowType WindowType,
float HopSize,
EAudioSpectrumType SpectrumType
)

 Start spectrum analysis of the audio output. Sound/SoundSubmix.h
  • BlueprintCallable
  • Category="Audio|Analysis"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay=1)

void StartSpectralAnalysis ( FAudioDevice* InDevice,
EFFTSize FFTSize,
EFFTPeakInterpolationMethod InterpolationMethod,
EFFTWindowType WindowType,
float HopSize,
EAudioSpectrumType SpectrumType
)

   Sound/SoundSubmix.h  

void StopEnvelopeFollowing ( const UObject* WorldContextObject
)

 Start envelope following the submix output. Register with OnSubmixEnvelope to receive envelope follower data in BP. Sound/SoundSubmix.h
  • BlueprintCallable
  • Category="Audio|EnvelopeFollowing"
  • Meta=(WorldContext="WorldContextObject")

void StopEnvelopeFollowing ( FAudioDevice* InDevice
)

   Sound/SoundSubmix.h  

void StopRecordingOutput ( const UObject* WorldContextObject,
EAudioRecordingExportType ExportType,
const FString& Name,
FString Path,
USoundWave* ExistingSoundWaveToOverwrite
)

 Finish recording the audio from this submix and export it as a wav file or a USoundWave. Sound/SoundSubmix.h
  • BlueprintCallable
  • Category="Audio|Bounce"
  • Meta=(WorldContext="WorldContextObject", DisplayName="Finish Recording Submix Output")

void StopRecordingOutput ( FAudioDevice* InDevice,
EAudioRecordingExportType ExportType,
const FString& Name,
FString Path,
USoundWave* ExistingSoundWaveToOverwrite
)

   Sound/SoundSubmix.h  

void StopSpectralAnalysis ( const UObject* WorldContextObject
)

 Stop spectrum analysis of the audio output. Sound/SoundSubmix.h
  • BlueprintCallable
  • Category="Audio|Analysis"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay=1)

void StopSpectralAnalysis ( FAudioDevice* InDevice
)

   Sound/SoundSubmix.h  

Protected

Name Remarks Include Path Unreal Specifiers

void HandleVersionMigration ( const int32 Version
)

   Sound/SoundSubmix.h  

void InitDeprecatedDefaults()

   Sound/SoundSubmix.h  

void PushModulationChanges()

 Send submix modulation changes to audio devices. Sound/SoundSubmix.h  

void SetDryVolumeModulation ( const FSoundModulationDestinationSettings& InVolMod
)

   Sound/SoundSubmix.h
  • BlueprintCallable
  • BlueprintInternalUseOnly

void SetOutputVolumeModulation ( const FSoundModulationDestinationSettings& InVolMod
)

 Custom settors for Modulation Destinations. Sound/SoundSubmix.h
  • BlueprintCallable
  • BlueprintInternalUseOnly

void SetWetVolumeModulation ( const FSoundModulationDestinationSettings& InVolMod
)

   Sound/SoundSubmix.h
  • BlueprintCallable
  • BlueprintInternalUseOnly

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Sound/SoundSubmix.h  

virtual void PostLoad()

   Sound/SoundSubmix.h  

virtual void Serialize ( FArchive& Ar
)

   Sound/SoundSubmix.h  

Static

Name Remarks Include Path Unreal Specifiers

static FAudioDevice * GetAudioDeviceFrom ( const UObject* WorldContextObject
)

 Return the audio device that corresponds to the provided world context object. Sound/SoundSubmix.h  

static FSoundSpectrumAnalyzerDelegateSettings GetSpectrumAnalysisDelegateSettings ( const TArray< FSoundSubmixSpectralAnalysisBandSettings >& InBandSettings,
float UpdateRate,
float DecibelNoiseFloor,
bool bDoNormalize,
bool bDoAutoRange,
float AutoRangeAttackTime,
float AutoRangeReleaseTime
)

   Sound/SoundSubmix.h  

static FSoundSpectrumAnalyzerSettings GetSpectrumAnalyzerSettings ( EFFTSize FFTSize,
EFFTPeakInterpolationMethod InterpolationMethod,
EFFTWindowType WindowType,
float HopSize,
EAudioSpectrumType SpectrumType
)

   Sound/SoundSubmix.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
DryLevel_DEPRECATED float   Sound/SoundSubmix.h  
OutputVolume_DEPRECATED float Forever deprecated properties. These must be kept to always be able to migrate older assets. Sound/SoundSubmix.h  
WetLevel_DEPRECATED float   Sound/SoundSubmix.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page