1. Epic GamesDeveloper
  3. FMixerSubmix

FMixerSubmix

Unreal Engine C++ API Reference > Runtime > AudioMixer

References

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

Syntax

class FMixerSubmix

Variables

  Type Name Description
Protected variable TUniquePtr< IAudioLink > AudioLinkInstance  
Protected variable double AutoDisableTime The time to wait to disable the submix if the auto-disablement is active.
Protected variable uint8: 1 bAutoDisable Whether or not auto-disablement is enabled. If true, the submix will disable itself.
Protected variable uint8: 1 bIsBackgroundMuted Whether or not this submix is muted.
Protected variable uint8: 1 bIsCurrentlyDisabled Whether or not we're currently disabled (i.e. the submix has been silent)
Protected variable FThreadSafeBool bIsEnvelopeFollowing Bool set to true when envelope following is enabled.
Protected variable uint8: 1 bIsRecording Bool set to true when this submix is recording data.
Protected variable uint8: 1 bIsSilent Whether or not the submix is currently rendering audio. I.e. audio was sent to it and mixing it, or any of its child submixes are rendering audio.
Protected variable FThreadSafeBool bIsSpectrumAnalyzing Bool set to true when spectrum analysis is enabled.
Protected variable FCriticalSection BufferListenerCriticalSection Critical section used for modifying and interacting with buffer listeners.
Protected variable TArray< ISubmixBufferListener * > BufferListeners List of submix buffer listeners.
Protected variable TMap< uint32, FChildSubmixInfo > ChildSubmixes Child submixes.
Protected variable TQueue< TFunction< void()> > CommandQueue Submix command queue to shuffle commands from audio thread to audio render thread.
Protected variable float CurrentDryLevel  
Protected variable float CurrentOutputVolume  
Protected variable float CurrentWetLevel  
Protected variable FAlignedFloatBuffer DownmixedBuffer  
Protected variable FAlignedFloatBuffer DryChannelBuffer The dry channel buffer.
Protected variable FModulationDestination DryLevelMod  
Protected variable float DryLevelModifier  
Protected variable float DryModBaseDb  
Protected variable FCriticalSection EffectChainMutationCriticalSection Critical section for mutation of the effect chain.
Protected variable FAlignedFloatBuffer EffectChainOutputBuffer  
Protected variable TArray< FSubmixEffectFadeInfo > 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).
Protected variable FEndpointData EndpointData  
Protected variable FCriticalSection EnvelopeCriticalSection  
Protected variable Audio::FEnvelopeFollower EnvelopeFollower  
Protected variable int32 EnvelopeNumChannels  
Protected variable float[8] EnvelopeValues Envelope following data.
Protected variable uint32 Id This mixer submix's Id.
Protected variable FAlignedFloatBuffer InputBuffer  
Protected variable FMixerDevice * MixerDevice Owning mixer device.
Protected variable TMap< FMixerSourceVoice *, FSubmixVoiceData > MixerSourceVoices Map of mixer source voices with a given send level for this submix.
Protected variable FAlignedFloatBuffer MonoMixBuffer This buffer is used to downmix the submix output to mono before submitting it to the SpectrumAnalyzer.
Protected variable int32 NumChannels  
Protected variable int32 NumSamples  
Protected variable int32 NumSubmixEffects Returns the number of submix effects.
Protected variable FOnSubmixEnvelope OnSubmixEnvelope Multi-cast delegate to broadcast envelope data from this submix instance.
Protected variable TWeakObjectPtr< const USoundSubmixBase > OwningSubmixObject Handle back to the owning USoundSubmix. Used when the device is shutdown to prematurely end a recording.
Protected variable TWeakPtr< FMixerSubmix, ESPMode::ThreadSafe > ParentSubmix Parent submix.
Protected variable Audio::FPatchSplitter PatchSplitter  
Protected variable FCriticalSection RecordingCriticalSection Critical section used for when we are appending recorded data.
Protected variable FAlignedFloatBuffer RecordingData This buffer is used for recorded output of the submix.
Protected variable FAlignedFloatBuffer ScratchBuffer  
Protected variable double SilenceTimeStartSeconds The time that the first full silent buffer was detected in the submix. Submix will auto-disable if the timeout is reached and the submix has bAutoDisable set to true.
Protected variable FSoundfieldStreams SoundfieldStreams  
Protected variable FAlignedFloatBuffer SourceInputBuffer  
Protected variable TArray< FSpectrumAnalysisDelegateInfo > SpectralAnalysisDelegates  
Protected variable TSharedPtr< FAsyncSpectrumAnalyzer, ESPMode::ThreadSafe > SpectrumAnalyzer  
Protected variable FCriticalSection SpectrumAnalyzerCriticalSection Spectrum analyzer. Created and destroyed on the audio thread.
Protected variable FSoundSpectrumAnalyzerSettings SpectrumAnalyzerSettings  
Protected variable FAlignedFloatBuffer SubmixChainMixBuffer  
Protected variable FString SubmixName The name of this submix (the owning USoundSubmix)
Protected variable float TargetDryLevel  
Protected variable float TargetOutputVolume  
Protected variable float TargetWetLevel  
Protected variable FModulationDestination VolumeMod  
Protected variable float VolumeModBaseDb  
Protected variable float VolumeModifier Modifiers set from BP code
Protected variable FModulationDestination WetLevelMod  
Protected variable float WetLevelModifier  
Protected variable float WetModBaseDb  

Constructors

  Type Name Description
Public function  

FMixerSubmix ( FMixerDevice* InMixerDevice
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddChildSubmix ( TWeakPtr< FMixerSubmix, ESPMode::ThreadSafe > Submix
)

 Adds the given submix to this submix's children.
Public function void

AddEnvelopeFollowerDelegate ( const FOnSubmixEnvelopeBP& OnSubmixEnvelopeBP
)

 Adds an envelope follower delegate.
Public function void

AddOrSetSourceVoice ( FMixerSourceVoice* InSourceVoice,
const float SendLevel,
EMixerSourceSubmixSendStage InSubmixSendStage
)

 Add (if not already added) or sets the amount of the source voice's send amount.
Public function FPatchOutputStrongPtr

AddPatch ( float InGain
)

  
Public function void

AddSoundEffectSubmix ( FSoundEffectSubmixPtr InSoundEffectSubmix
)

 Appends the effect submix to the effect submix chain.
Public function void

AddSpectralAnalysisDelegate ( const FSoundSpectrumAnalyzerDelegateSettings& InDelegateSettings,
const FOnSubmixSpectralAnalysisBP& OnSubmixSpectralAnalysisBP
)

 Adds an spectral analysis delegate.
Public function void Broadcast the envelope and submix delegates on the game thread.
Public function void Clears all submix effects from the effect submix chain.
Public function void

ClearSubmixEffectChainOverride ( float InFadeTimeSec
)

 Clears any submix effect chain overrides in the given fade time in seconds.
Protected function Static void

DownmixBuffer ( const int32 InChannels,
const FAlignedFloatBuffer& InBuffer,
const int32 OutChannels,
FAlignedFloatBuffer& OutNewBuffer
)

 Down mix the given buffer to the desired down mix channel count.
Protected function bool

GenerateEffectChainAudio ( FSoundEffectSubmixInputData& InputData,
const FAlignedFloatBuffer& InAudioBuffer,
TArray< FSoundEffectSubmixPtr >& InEffectChain,
FAlignedFloatBuffer& OutBuffer
)

 Generates audio from the given effect chain into the given buffer.
Public function FSoundfieldSpeakerPositionalData  
Public function Const uint32

GetId ()

 Returns the mixer submix Id.
Public function FAudioPluginInitializationParams  
Public function FSoundfieldEncodingKey Get a unique key for this submix's format and settings.
Public function void

GetMagnitudeForFrequencies ( const TArray< float >& InFrequencies,
TArray< float >& OutMagnitudes
)

 Gets the most recent magnitude values for each corresponding value in InFrequencies (in Hz).
Public function int32 Returns the number of effects in this submix's effect chain.
Public function Const int32 Returns the number of wet effects in this submix.
Public function Const int32 Returns the output channels this submix is rendering to.
Public function Const int32 Returns the number of source voices currently a part of this submix.
Public function TWeakPtr< FMixerSubmix, ESPMode::ThreadSafe > Gets this submix's parent submix.
Public function void

GetPhaseForFrequencies ( const TArray< float >& InFrequencies,
TArray< float >& OutPhases
)

 Gets the most recent phase values for each corresponding value in InFrequencies (in Hz).
Public function Const int32 Returns the device sample rate this submix is rendering to.
Public function Const int32 Returns the size of the submix chain.
Public function ISoundfieldFactory *  
Protected function Const FName  
Public function ISoundfieldEncodingSettingsProxy &  
Public function Const int32 Gets the submix channels channels.
Public function FSoundEffectSubmixPtr

GetSubmixEffect ( const int32 InIndex
)

 Returns the submix effect at the given effect chain index.
Protected function TUniquePtr< ISoundfieldTranscodeStream >

GetTranscoderForChildSubmix ( const TSharedPtr< Audio::FMixerSubmix, ESPMode::ThreadSafe >& InChildSubmix
)

  
Public function void

Init ( const USoundSubmixBase* InSoundSubmix,
bool bAllowReInit
)

 Initialize the submix object with the USoundSubmix ptr. Sets up child and parent connects.
Protected function void Initialize the submix internal.
Public function Const bool Returns true if this submix sends it's audio to the default endpoint.
Public function Const bool Returns true if this is an endpoint type that should no-op for this platform.
Public function Const bool Returns true if this submix sends its audio to an IAudioEndpoint.
Public function Const bool Returns true if the submix is currently rendering audio. The current rendering time is passed in.
Public function Const bool Returns true if this submix sends its audio to an ISoundfieldEndpoint.
Public function Const bool Returns true if this submix is encoded to a soundfield.
Public function Const bool

IsValid ()

 Checks to see if submix is valid.
Protected function void

MixBufferDownToMono ( const FAlignedFloatBuffer& InBuffer,
int32 NumInputChannels,
FAlignedFloatBuffer& OutBuffer
)

  
Protected function void Calls ProcessAudio on the child submix, performs all necessary conversions and mixes in it's resulting audio.
Protected function void

MixInSource ( const ISoundfieldAudioPacket& InAudio,
const ISoundfieldEncodingSettingsProxy& InSettings,
ISoundfieldAudioPacket& PacketToSumTo
)

 Encode a source and sum it into the mixed soundfield.
Public function void

OnStartRecordingOutput ( float ExpectedDuration
)

 This is called by the corresponding USoundSubmix when StartRecordingOutput is called.
Public function FAlignedFloatBuffer &

OnStopRecordingOutput ( float& OutNumChannels,
float& OutSampleRate
)

 This is called by the corresponding USoundSubmix when StopRecordingOutput is called.
Public function void This is called by the corresponding USoundSubmix when PauseRecording is called.
Public function void Function which processes audio.
Public function void Function which processes audio.
Public function void This should be called if this submix doesn't send it's audio to a parent submix, but rather an external endpoint.
Protected function void Pump command queue.
Public function void Register buffer listener with this submix.
Public function void

RemoveChildSubmix ( TWeakPtr< FMixerSubmix, ESPMode::ThreadSafe > SubmixWeakPtr
)

 Removes the given submix from this submix's children.
Public function void

RemoveSoundEffectSubmix ( uint32 SubmixPresetId
)

 Removes the submix effect from the effect submix chain.
Public function void

RemoveSoundEffectSubmixAtIndex ( int32 InIndex
)

 Removes the submix effect from the effect submix chain at the given submix index.
Public function void

RemoveSourceVoice ( FMixerSourceVoice* InSourceVoice
)

 Removes the given source voice from the submix.
Public function void

RemoveSpectralAnalysisDelegate ( const FOnSubmixSpectralAnalysisBP& OnSubmixSpectralAnalysisBP
)

 Removes an existing spectral analysis delegate.
Public function void

ReplaceSoundEffectSubmix ( int32 InIndex,
FSoundEffectSubmixPtr InEffectInstance
)

 Swaps effect for provided submix at the given index. Fails if effect at index doesn't exist
Public function void This is called by the corresponding USoundSubmix when ResumeRecording is called.
Public function void  
Public function void

SetAutoDisable ( bool bInAutoDisable
)

 Set whether or not this submix is told to auto disable.
Public function void

SetAutoDisableTime ( float InAutoDisableTime
)

 Sets the auto-disable time.
Public function void

SetBackgroundMuted ( bool bInMuted
)

 Whether or not this submix instance is muted.
Public function void

SetDryLevel ( float InDryLevel
)

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

SetModulationBaseLevels ( float InVolumeModBaseDb,
float InWetModeBaseDb,
float InDryModBaseDb
)

 Update modulation settings of the submix with Decibel values.
Public function void

SetOutputVolume ( float InOutputLevel
)

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

SetParentSubmix ( TWeakPtr< FMixerSubmix, ESPMode::ThreadSafe > Submix
)

 Sets the parent submix to the given submix.
Public function void

SetSoundfieldFactory ( ISoundfieldFactory* InSoundfieldFactory
)

 This must be called on the entire submix graph before calling SetupSoundfieldStreams.
Public function void

SetSubmixEffectChainOverride ( const TArray< FSoundEffectSubmixPtr >& InSubmixEffectPresetChain,
float InFadeTimeSec
)

 Sets a submix effect chain override with the given fade time in seconds.
Public function void  
Public function void  
Protected function void  
Protected function void  
Protected function void

SetUpSoundfieldPositionalData ( const TSharedPtr< Audio::FMixerSubmix, ESPMode::ThreadSafe >& InParentSubmix
)

 This sets up the ambisonics positional data for speakers, based on what new format we need to convert to.
Protected function void Check to see if we need to decode from ambisonics for parent.
Public function void

SetupSoundfieldStreams ( const USoundfieldEncodingSettingsBase* SoundfieldSettings,
TArray< USoundfieldEffectBase* >& Processors,
ISoundfieldFactory* InSoundfieldFactory
)

 Updates settings, potentially creating or removing ambisonics streams based on what types of submixes this submix is connected to.
Public function void

SetWetLevel ( float InWetLevel
)

 Sets the wet level of the submix in linear gain.
Public function void

StartEnvelopeFollowing ( int32 AttackTime,
int32 ReleaseTime
)

 Starts envelope following with the given attack time and release time.
Public function void Initializes a new FFT analyzer for this submix and immediately begins feeding audio to it.
Public function void Stops envelope following the submix.
Public function void Terminates whatever FFT Analyzer is being used for this submix.
Protected function void

SubmixCommand ( TFunction< void()> Command
)

 Add command to the command queue.
Public function void  
Public function void Unregister buffer listener with this submix.
Public function void  
Public function void  
Protected function void

UpdateListenerRotation ( const FQuat& InRotation
)

  
Public function void

UpdateModulationSettings ( const TSet< TObjectPtr< USoundModulatorBase >>& InOutputModulators,
const TSet< TObjectPtr< USoundModulatorBase >>& InWetLevelModulators,
const TSet< TObjectPtr< USoundModulatorBase >>& InDryLevelModulators
)

 Update modulation settings of the submix.

Classes

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page