1. Epic GamesDeveloper
  3. USoundSubmix

USoundSubmix

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

Unreal Engine C++ API Reference > Runtime > Engine > Sound

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Sound/SoundSubmix.h
Include #include "Sound/SoundSubmix.h"

Syntax

class USoundSubmix : public USoundSubmixWithParentBase

Remarks

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

Variables

  Type Name Description
Public variable TObjectPtr< USoundfieldEncodingSettingsBase > AmbisonicsPluginSettings Optional settings used by plugins which support ambisonics file playback.
Public variable TObjectPtr< UAudioLinkSettingsAbstract > AudioLinkSettings Optional Audio Link Settings Object
Public variable uint8: 1 bMuteWhenBackgrounded Mute this submix when the application is muted or in the background.
Public variable uint8: 1 bSendToAudioLink Whether to send this Submix to AudioLink (when AudioLink is Enabled)
Public variable float DryLevel Deprecated The dry level of the submix. Applied before submix effects and analysis are performed.
Public variable FSoundModulationDestinationSettings DryLevelModulation The dry level of the submix in Decibels. Applied before submix effects and analysis are performed.
Public variable int32 EnvelopeFollowerAttackTime The attack time in milliseconds for the envelope follower.
Public variable int32 EnvelopeFollowerReleaseTime The release time in milliseconds for the envelope follower.
Public variable FOnSubmixRecordedFileDone OnSubmixRecordedFileDone Blueprint delegate for when a recorded file is finished exporting.
Public variable float OutputVolume Deprecated The output volume of the submix.
Public variable FSoundModulationDestinationSettings OutputVolumeModulation The output volume of the submix in Decibels.
Protected variable TUniquePtr< Audio::FAudioRecordingData > RecordingData State handling for bouncing output.
Public variable TArray< TObjectPtr< USoundEffectSubmixPreset > > SubmixEffectChain  
Public variable float WetLevel Deprecated The wet level of the submix. Applied after submix effects and analysis are performed.
Public variable FSoundModulationDestinationSettings WetLevelModulation The wet level of the submixin Decibels. Applied after submix effects and analysis are performed.

Constructors

  Type Name Description
Public function  

USoundSubmix ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

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

 Adds an envelope follower delegate to the submix when envelope following is enabled on this submix.
Public function 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.
Public function Static FSoundSpectrumAnalyzerDelegateSettings

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

  
Public function Static FSoundSpectrumAnalyzerSettings

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

  
Public function void

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

 Remove a spectral analysis delegate.
Public function void

SetSubmixDryLevel ( const UObject* WorldContextObject,
float InDryLevel
)

 Sets the output volume of the submix in linear gain.
Public function void

SetSubmixOutputVolume ( const UObject* WorldContextObject,
float InOutputVolume
)

 Sets the output volume of the submix in linear gain.
Public function void

SetSubmixWetLevel ( const UObject* WorldContextObject,
float InWetLevel
)

 Sets the output volume of the submix in linear gain.
Public function void  
Public function void

StartEnvelopeFollowing ( const UObject* WorldContextObject
)

 Start envelope following the submix output. Register with OnSubmixEnvelope to receive envelope follower data in BP.
Public function void

StartRecordingOutput ( const UObject* WorldContextObject,
float ExpectedDuration
)

 Start recording the audio from this submix.
Public function void

StartRecordingOutput ( FAudioDevice* InDevice,
float ExpectedDuration
)

  
Public function void

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

 Start spectrum analysis of the audio output.
Public function void

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

  
Public function void

StopEnvelopeFollowing ( const UObject* WorldContextObject
)

 Start envelope following the submix output. Register with OnSubmixEnvelope to receive envelope follower data in BP.
Public function void  
Public function 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.
Public function void

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

  
Public function void

StopSpectralAnalysis ( const UObject* WorldContextObject
)

 Stop spectrum analysis of the audio output.
Public function void  

Overridden from UObject

  Type Name Description
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Protected function Virtual void Handles reading, writing, and reference collecting using FArchive.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page