Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

USoundSubmix

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USoundSubmixBase

USoundSubmixWithParentBase

USoundSubmix

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

	Name	Description
USoundfieldEnco...	AmbisonicsPluginSettings	Optional settings used by plugins which support ambisonics file playback.
uint8: 1	bMuteWhenBackgrounded	Mute this submix when the application is muted or in the background.
int32	EnvelopeFollowerAttackTime	The attack time in milliseconds for the envelope follower.
int32	EnvelopeFollowerReleaseTime	The release time in milliseconds for the envelope follower.
FOnSubmixRecord...	OnSubmixRecordedFileDone	Blueprint delegate for when a recorded file is finished exporting.
float	OutputVolume	The output volume of the submix. Applied after submix effects and analysis are performed.
TUniquePtr< Aud...	RecordingData	State handling for bouncing output.
TArray< USoundE...	SubmixEffectChain

Constructors

	Name	Description
	USoundSubmix ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddEnvelopeFollowerDelegate ( const UObject* WorldContextObj..., const FOnSubmixEnvelopeBP& OnSubmi... )
void	SetSubmixOutputVolume ( const UObject* WorldContextObj..., float InOutputVolume )	Sets the output volume of the submix.
void	StartEnvelopeFollowing ( const UObject* WorldContextObj... )	Start envelope following the submix output. Register with OnSubmixEnvelope to receive envelope follower data in BP.
void	StartEnvelopeFollowing ( FAudioDevice* InDevice )
void	StartRecordingOutput ( const UObject* WorldContextObj..., float ExpectedDuration )	Start recording the audio from this submix.
void	StartRecordingOutput ( FAudioDevice* InDevice, float ExpectedDuration )
void	StopEnvelopeFollowing ( const UObject* WorldContextObj... )	Start envelope following the submix output. Register with OnSubmixEnvelope to receive envelope follower data in BP.
void	StopEnvelopeFollowing ( FAudioDevice* InDevice )
void	StopRecordingOutput ( const UObject* WorldContextObj..., EAudioRecordingExportType ExportTyp..., const FString& Name, FString Path, USoundWave* ExistingSoundWaveT... )	Finish recording the audio from this submix and export it as a wav file or a USoundWave.
void	StopRecordingOutput ( FAudioDevice* InDevice, EAudioRecordingExportType ExportTyp..., const FString& Name, FString Path, USoundWave* ExistingSoundWaveT... )

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss