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

> Unreal Engine API Reference > Runtime > AudioMixer > FMixerSubmix

Light Theme

Dark Theme

FMixerSubmix

Windows

MacOS

Linux

References

Module	AudioMixer
Header	/Engine/Source/Runtime/AudioMixer/Public/AudioMixerSubmix.h
Include	#include "AudioMixerSubmix.h"

Syntax

class FMixerSubmix

Variables

	Name	Description
uint8: 1	bIsBackgroundMuted	Whether or not this submix is muted.
FThreadSafeBool	bIsEnvelopeFollowing	Bool set to true when envelope following is enabled.
uint8: 1	bIsRecording	Bool set to true when this submix is recording data.
FThreadSafeBool	bIsSpectrumAnalyzing	Bool set to true when spectrum analysis is enabled.
FCriticalSectio...	BufferListenerCriticalSection	Critical section used for modifying and interacting with buffer listeners.
TArray< ISubmix...	BufferListeners	List of submix buffer listeners.
TMap< uint32, F...	ChildSubmixes	Child submixes.
TQueue< TFuncti...	CommandQueue	Submix command queue to shuffle commands from audio thread to audio render thread.
float	CurrentDryLevel
float	CurrentOutputVolume
float	CurrentWetLevel
AlignedFloatBuf...	DownmixedBuffer
AlignedFloatBuf...	DryChannelBuffer	The dry channel buffer.
FCriticalSectio...	EffectChainMutationCriticalSection	Critical section for mutation of the effect chain.
AlignedFloatBuf...	EffectChainOutputBuffer
TArray< FSubmix...	EffectChains	The array of submix effect overrides. There may be more than one if multiple are fading out. There should be only one fading in (the current override).
FEndpointData	EndpointData
FCriticalSectio...	EnvelopeCriticalSection
TArray< Audio::...	EnvelopeFollowers
int32	EnvelopeNumChannels
float[8]	EnvelopeValues	Envelope following data.
uint32	Id	This mixer submix's Id.
AlignedFloatBuf...	InputBuffer
FMixerDevice &#...	MixerDevice	Owning mixer device.
TMap< FMixerSou...	MixerSourceVoices	Map of mixer source voices with a given send level for this submix.
AlignedFloatBuf...	MonoMixBuffer	This buffer is used to downmix the submix output to mono before submitting it to the SpectrumAnalyzer.
int32	NumChannels
int32	NumSamples
int32	NumSubmixEffects	Returns the number of submix effects.
FOnSubmixEnvelo...	OnSubmixEnvelope	Multi-cast delegate to broadcast envelope data from this submix instance.
TWeakObjectPtr<...	OwningSubmixObject	Handle back to the owning USoundSubmix. Used when the device is shutdown to prematurely end a recording.
TWeakPtr< FMixe...	ParentSubmix	Parent submix.
Audio::FPatchSp...	PatchSplitter
FCriticalSectio...	RecordingCriticalSection	Critical section used for when we are appending recorded data.
AlignedFloatBuf...	RecordingData	This buffer is used for recorded output of the submix.
AlignedFloatBuf...	ScratchBuffer
FSoundfieldStre...	SoundfieldStreams
AlignedFloatBuf...	SourceInputBuffer
TArray< FSpectr...	SpectralAnalysisDelegates
TSharedPtr< FAs...	SpectrumAnalyzer
FCriticalSectio...	SpectrumAnalyzerCriticalSection	Spectrum analyzer. Created and destroyed on the audio thread.
FSoundSpectrumA...	SpectrumAnalyzerSettings
AlignedFloatBuf...	SubmixChainMixBuffer
float	TargetDryLevel
float	TargetOutputVolume
float	TargetWetLevel

Constructors

	Name	Description
	FMixerSubmix ( FMixerDevice* InMixerDevice )

Destructors

	Name	Description
	~FMixerSubmix()

Functions

	Name	Description
void	AddChildSubmix ( TWeakPtr< FMixerSubmix, ESPMode::Th... )	Adds the given submix to this submix's children.
void	AddEnvelopeFollowerDelegate ( const FOnSubmixEnvelopeBP& OnSubmi... )	Adds an envelope follower delegate.
void	AddOrSetSourceVoice ( FMixerSourceVoice* InSourceVoi..., const float SendLevel, EMixerSourceSubmixSendStage InSubmi... )	Add (if not already added) or sets the amount of the source voice's send amount.
FPatchOutput...	AddPatch ( float InGain )
void	AddSoundEffectSubmix ( FSoundEffectSubmixPtr InSoundEffect... )	Appends the effect submix to the effect submix chain.
void	AddSpectralAnalysisDelegate ( const FSoundSpectrumAnalyzerDelegat..., const FOnSubmixSpectralAnalysisBP&... )	Adds an spectral analysis delegate.
void	BroadcastDelegates()	Broadcast the envelope and submix delegates on the game thread.
void	ClearSoundEffectSubmixes()	Clears all submix effects from the effect submix chain.
void	ClearSubmixEffectChainOverride ( float InFadeTimeSec )	Clears any submix effect chain overrides in the given fade time in seconds.
void	DownmixBuffer ( const int32 InChannels, const AlignedFloatBuffer& InBuffer, const int32 OutChannels, AlignedFloatBuffer& OutNewBuffer )	Down mix the given buffer to the desired down mix channel count.
bool	GenerateEffectChainAudio ( FSoundEffectSubmixInputData& Input..., AlignedFloatBuffer& InAudioBuffer, TArray< FSoundEffectSubmixPtr >& I..., AlignedFloatBuffer& OutBuffer )	Generates audio from the given effect chain into the given buffer.
FSoundfieldS...	GetDefaultPositionalDataForAudioDevice()
uint32	GetId()	Returns the mixer submix Id.
FAudioPlugin...	GetInitializationParamsForSoundfieldStream()
FSoundfieldE...	GetKeyForSubmixEncoding()	Get a unique key for this submix's format and settings.
void	GetMagnitudeForFrequencies ( const TArray< float >& InFrequenci..., TArray< float >& OutMagnitudes )	Gets the most recent magnitude values for each corresponding value in InFrequencies (in Hz).
int32	GetNumChainEffects()	Returns the number of effects in this submix's effect chain.
int32	GetNumEffects()	Returns the number of wet effects in this submix.
int32	GetNumOutputChannels()	Returns the output channels this submix is rendering to.
int32	GetNumSourceVoices()	Returns the number of source voices currently a part of this submix.
TWeakPtr< FM...	GetParentSubmix()	Gets this submix's parent submix.
void	GetPhaseForFrequencies ( const TArray< float >& InFrequenci..., TArray< float >& OutPhases )	Gets the most recent phase values for each corresponding value in InFrequencies (in Hz).
int32	GetSampleRate()	Returns the device sample rate this submix is rendering to.
int32	GetSizeOfSubmixChain()	Returns the size of the submix chain.
ISoundfieldF...	GetSoundfieldFactory()
FName	GetSoundfieldFormat()
ISoundfieldE...	GetSoundfieldSettings()
int32	GetSubmixChannels()	Gets the submix channels channels.
FSoundEffect...	GetSubmixEffect ( const int32 InIndex )	Returns the submix effect at the given effect chain index.
TUniquePtr< ...	GetTranscoderForChildSubmix ( const TSharedPtr< Audio::FMixerSubm... )
void	Init ( const USoundSubmixBase* InSoun..., bool bAllowReInit )	Initialize the submix object with the USoundSubmix ptr. Sets up child and parent connects.
void	InitInternal()	Initialize the submix internal.
bool	IsDefaultEndpointSubmix()	Returns true if this submix sends it's audio to the default endpoint.
bool	IsExternalEndpointSubmix()	Returns true if this submix sends its audio to an IAudioEndpoint.
bool	IsSoundfieldEndpointSubmix()	Returns true if this submix sends its audio to an ISoundfieldEndpoint.
bool	IsSoundfieldSubmix()	Returns true if this submix is encoded to a soundfield.
bool	IsValid()	Checks to see if submix is valid.
void	MixBufferDownToMono ( const AlignedFloatBuffer& InBuffer, int32 NumInputChannels, AlignedFloatBuffer& OutBuffer )
void	MixInChildSubmix ( FChildSubmixInfo& Child, ISoundfieldAudioPacket& PacketToSu... )	Calls ProcessAudio on the child submix, performs all neccessary conversions and mixes in it's resulting audio.
void	MixInSource ( const ISoundfieldAudioPacket& InAu..., const ISoundfieldEncodingSettingsPr..., ISoundfieldAudioPacket& PacketToSu... )	Encode a source and sum it into the mixed soundfield.
void	OnStartRecordingOutput ( float ExpectedDuration )	This is called by the corresponding USoundSubmix when StartRecordingOutput is called.
AlignedFloat...	OnStopRecordingOutput ( float& OutNumChannels, float& OutSampleRate )	This is called by the corresponding USoundSubmix when StopRecordingOutput is called.
void	PauseRecordingOutput()	This is called by the corresponding USoundSubmix when PauseRecording is called.
void	ProcessAudio ( ISoundfieldAudioPacket& OutputAudi... )	Function which processes audio.
void	ProcessAudio ( AlignedFloatBuffer& OutAudio )	Function which processes audio.
void	ProcessAudioAndSendToEndpoint()	This should be called if this submix doesn't send it's audio to a parent submix, but rather an external endpoint.
void	PumpCommandQueue()	Pump command queue.
void	RegisterBufferListener ( ISubmixBufferListener* BufferL... )	Register buffer listener with this submix.
void	RemoveChildSubmix ( TWeakPtr< FMixerSubmix, ESPMode::Th... )	Removes the given submix from this submix's children.
void	RemoveSoundEffectSubmix ( uint32 SubmixPresetId )	Removes the submix effect from the effect submix chain.
void	RemoveSoundEffectSubmixAtIndex ( int32 InIndex )	Removes the submix effect from the effect submix chain at the given submix index.
void	RemoveSourceVoice ( FMixerSourceVoice* InSourceVoi... )	Removes the given source voice from the submix.
void	RemoveSpectralAnalysisDelegate ( const FOnSubmixSpectralAnalysisBP&... )	Removes an existing spectral analysis delegate.
void	ReplaceSoundEffectSubmix ( int32 InIndex, FSoundEffectSubmixPtr InEffectInsta... )	Swaps effect for provided submix at the given index. Fails if effect at index doesn't exist
void	ResumeRecordingOutput()	This is called by the corresponding USoundSubmix when ResumeRecording is called.
void	SetBackgroundMuted ( bool bInMuted )	Whether or not this submix instance is muted.
void	SetDryLevel ( float InDryLevel )	Sets the static output volume of the submix.
void	SetOutputVolume ( float InOutputLevel )	Sets the output level of the submix.
void	SetParentSubmix ( TWeakPtr< FMixerSubmix, ESPMode::Th... )	Sets the parent submix to the given submix.
void	SetSoundfieldFactory ( ISoundfieldFactory* InSoundfie... )	This must be called on the entire submix graph before calling SetupSoundfieldStreams.
void	SetSubmixEffectChainOverride ( const TArray< FSoundEffectSubmixPtr..., float InFadeTimeSec )	Sets a submix effect chain override with the given fade time in seconds.
void	SetupEndpoint ( ISoundfieldEndpointFactory* In..., const USoundfieldEndpointSettingsBa... )
void	SetupEndpoint ( IAudioEndpointFactory* InFacto..., const UAudioEndpointSettingsBase&#... )
void	SetupSoundfieldEncodersForChildren()
void	SetupSoundfieldEncodingForChild ( FChildSubmixInfo& InChild )
void	SetUpSoundfieldPositionalData ( const TSharedPtr< Audio::FMixerSubm... )	This sets up the ambisonics positional data for speakers, based on what new format we need to convert to.
void	SetupSoundfieldStreamForParent()	Check to see if we need to decode from ambisonics for parent.
void	SetupSoundfieldStreams ( const USoundfieldEncodingSettingsBa..., TArray< USoundfieldEffectBase..., ISoundfieldFactory InSoundfie... )	Updates settings, potentially creating or removing ambisonics streams based on what types of submixes this submix is connected to.
void	SetWetLevel ( float InWetLevel )	Sets the wet level of the submix.
void	StartEnvelopeFollowing ( int32 AttackTime, int32 ReleaseTime )	Starts envelope following with the given attack time and release time.
void	StartSpectrumAnalysis ( const FSoundSpectrumAnalyzerSetting... )	Initializes a new FFT analyzer for this submix and immediately begins feeding audio to it.
void	StopEnvelopeFollowing()	Stops envelope following the submix.
void	StopSpectrumAnalysis()	Terminates whatever FFT Analyzer is being used for this submix.
void	SubmixCommand ( TFunction< void()> Command )	Add command to the command queue.
void	TeardownSoundfieldStreams()
void	UnregisterBufferListener ( ISubmixBufferListener* BufferL... )	Unregister buffer listener with this submix.
void	UpdateEndpointSettings ( TUniquePtr< IAudioEndpointSettingsP... )
void	UpdateEndpointSettings ( TUniquePtr< ISoundfieldEndpointSett... )
void	UpdateListenerRotation ( const FQuat& InRotation )

Classes

	Name	Description
	FEndpointData
	FSoundfieldEffectProcessorData	Individual processor in our
	FSoundfieldStreams
	FSpectralAnalysisBandInfo
	FSpectrumAnalysisDelegateInfo
	FSubmixEffectFadeInfo

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

Take our survey

Dismiss