1. Epic GamesDeveloper
  3. FMixerDevice

FMixerDevice

API > API/Runtime > API/Runtime/AudioMixer

Inheritance Hierarchy

  • FAudioDevice
  • IAudioMixer
  • FGCObject
  • FMixerDevice

References

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

Syntax

class FMixerDevice :  
    public FAudioDevice,  
    public IAudioMixer,  
    public FGCObject

Variables

  Type Name Description
Protected variable TArray< FTransform > ListenerTransforms  
Public variable FQuartzClockManager QuantizedEventClockManager Clock Manager for quantized event handling on Audio Render Thread.
Public variable FCriticalSection QuartzPersistentStateCritSec Technically, in editor, multiple UQuartz(World)Subsystem's will reference the same FMixerDevice object.
Public variable TSharedPtr< FPersistentQuartzSubsystemData, ESPMode::ThreadSafe > QuartzSubsystemData Keep a reference alive to UQuartzSubsystem state that needs to persist across level transitions (UWorld destruction.

Constructors

  Type Name Description
Public function  

FMixerDevice ( IAudioMixerPlatformInterface* InAudioMixerPlatform
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Virtual void

AddEnvelopeFollowerDelegate ( USoundSubmix* InSubmix,
const FOnSubmixEnvelopeBP& OnSubmixEnvelopeBP
)

  
Public function void

AddMainSubmixEffect ( FSoundEffectSubmixPtr SoundEffect
)

 Add submix effect to main submix.
Public function void

AddMasterSubmixEffect ( FSoundEffectSubmixPtr SoundEffect
)

 Renamed Main submix: these functions will be deprecated in a future release.
Public function Virtual FPatchOutputStrongPtr

AddPatchForSubmix ( uint32 InObjectId,
float InPatchGain
)

  
Public function Virtual void

AddReferencedObjects ( FReferenceCollector& Collector
)

  
Public function Virtual void

AddSpectralAnalysisDelegate ( USoundSubmix* InSubmix,
const FSoundSpectrumAnalyzerDelegateSettings& InDelegateSettings,
const FOnSubmixSpectralAnalysisBP& OnSubmixSpectralAnalysisBP
)

  
Public function int32

AddSubmixEffect ( USoundSubmix* InSoundSubmix,
FSoundEffectSubmixPtr SoundEffect
)

 Add submix effect to given submix.
Public function void

AudioRenderThreadCommand ( TFunction< void()> Command
)

 Pushes the command to a audio render thread command queue to be executed on render thread.
Public function Const void  
Public function Const void Functions which check the thread it's called on and helps make sure functions are called from correct threads.
Public function void Clear all submix effects from main submix.
Public function void  
Public function Virtual void

ClearSubmixEffectChainOverride ( USoundSubmix* InSoundSubmix,
float InFadeTimeSec
)

  
Public function void

ClearSubmixEffects ( USoundSubmix* InSoundSubmix
)

 Clear all submix effects from given submix.
Public function Virtual void

CountBytes ( FArchive& Ar
)

  
Public function Virtual FAudioEffectsManager *  
Public function Virtual FSoundSource *  
Public function Static void

CreateSynchronizedAudioTaskQueue ( AudioTaskQueueId QueueId
)

 Creates a queue for audio decode requests with a specific Id.
Public function Static void

DestroySynchronizedAudioTaskQueue ( AudioTaskQueueId QueueId,
bool RunCurrentQueue
)

 Destroys an audio decode task queue. Tasks currently queued up are optionally started.
Public function Virtual Const bool  
Public function Const void

DrawSubmixes ( FOutputDevice& InOutput,
const TArray< FString >& InArgs
)

 Debug Commands.
Public function Virtual void  
Public function Virtual void

FadeIn ()

  
Public function Virtual void

FadeOut ()

  
Public function FMixerSubmixPtr

FindSubmixInstanceByObjectId ( uint32 InObjectId
)

  
Public function Virtual void

FlushAudioRenderingCommands ( bool bPumpSynchronously
)

  
Public function Virtual void

FlushExtended ( UWorld* WorldToFlush,
bool bClearActivatedReverb
)

  
Public function void

GameThreadMPSCCommand ( TFunction< void()> InCommand
)

 Pushes the command to a MPSC queue to be executed on the game thread.
Public function Static void

Get2DChannelMap ( bool bIsVorbis,
const int32 NumSourceChannels,
const int32 NumOutputChannels,
const bool bIsCenterChannelOnly,
Audio::FAlignedFloatBuffer& OutChannelMap
)

  
Public function Const void

Get2DChannelMap ( bool bIsVorbis,
const int32 NumSourceChannels,
const bool bIsCenterChannelOnly,
Audio::FAlignedFloatBuffer& OutChannelMap
)

 Builds a channel gain matrix for a non-spatialized source. The non-static variation of this function queries AudioMixerDevice->NumOutputChannels directly which may not be thread safe.
Public function void

Get3DChannelMap ( const int32 InSubmixNumChannels,
const FWaveInstance* InWaveInstance,
const float EmitterAzimuth,
const float NonSpatiliazedFactor,
const TMap< EAudioMixerChannel::Type, float >* InOmniMap,
float InDefaultOmniValue,
Audio::FAlignedFloatBuffer& OutChannelMap
)

 Builds a 3D channel map for a spatialized source.
Public function Const double  
Public function Virtual Const void

GetAudioDeviceList ( TArray< FString >& OutAudioDeviceNames
)

  
Public function Const IAudioLinkFactory * AudioLink.
Public function Const IAudioMixerPlatformInterface * Retrieve a pointer to the currently active platform. Only use this if you know what you are doing. The returned IAudioMixerPlatformInterface will only be alive as long as this FMixerDevice is alive.
Public function Const double  
Public function Const double Audio thread tick timing relative to audio render thread timing.
Public function Virtual Const double  
Public function FMixerSubmixWeakPtr  
Public function Const const TArray< EAudioMixerChannel::Type > & Returns the channel array for the given submix channel type.
Public function Virtual bool

GetCurrentSourceEffectChain ( const uint32 SourceEffectChainId,
TArray< FSourceEffectChainEntry >& OutCurrentSourceEffectChainEntries
)

  
Public function Const const FChannelPositionInfo * Retrieves spherical locations of channels for a given submix format.
Public function TArray< Audio::FChannelPositionInfo > *

GetDefaultPositionMap ( int32 NumChannels
)

  
Public function Const int32  
Public function Const int32  
Public function FMixerSubmixWeakPtr  
Public function ISoundfieldFactory *

GetFactoryForSubmixInstance ( USoundSubmix* SoundSubmix
)

 If SoundSubmix is a soundfield submix, this will return the factory used to encode source audio to it's soundfield format.
Public function ISoundfieldFactory *  
Public function Virtual Const double  
Public function const TArray< FTransform > * Retrieves the listener transforms.
Public function Virtual void

GetMagnitudesForFrequencies ( USoundSubmix* InSubmix,
const TArray< float >& InFrequencies,
TArray< float >& OutMagnitudes
)

  
Public function FMixerSubmixWeakPtr  
Public function Virtual Const USoundSubmix &  
Public function FMixerSubmixWeakPtr  
Public function FMixerSubmixWeakPtr  
Public function FMixerSubmixWeakPtr  
Public function FMixerSourceVoice * Public Functions.
Public function Const EMonoChannelUpmixMethod  
Public function Virtual Const int32  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Virtual void

GetPhasesForFrequencies ( USoundSubmix* InSubmix,
const TArray< float >& InFrequencies,
TArray< float >& OutPhases
)

  
Public function Const const FAudioPlatformDeviceInfo &  
Public function Virtual Const FAudioPlatformSettings  
Public function Virtual Const FString  
Public function FMixerSubmixWeakPtr  
Public function FMixerSourceManager *  
Public function Const const FMixerSourceManager *  
Public function Const FMixerSubmixWeakPtr

GetSubmixInstance ( const USoundSubmixBase* SoundSubmix
)

  
Public function Virtual bool

HasCompressedAudioInfoClass ( USoundWave* SoundWave
)

  
Public function Virtual bool  
Protected function Virtual void  
Public function Const bool  
Public function Static bool

IsEndpointSubmix ( const USoundSubmixBase* InSubmix
)

  
Public function Virtual bool  
Public function Virtual Const bool Audio Device Properties.
Public function Static int

KickQueuedTasks ( AudioTaskQueueId QueueId
)

 "Kicks" all of the audio decode tasks currentlyt in the queue.
Public function Const FPatchOutputStrongPtr

MakePatch ( int32 InFrames,
int32 InChannels,
float InGain
)

  
Public function Virtual void  
Protected function Virtual void

OnListenerUpdated ( const TArray< FListener >& InListeners
)

  
Public function Virtual bool

OnProcessAudioStream ( FAlignedFloatBuffer& OutputBuffer
)

  
Public function Virtual void

PauseRecording ( USoundSubmix* InSubmix
)

  
Public function Virtual void

RegisterSoundSubmix ( USoundSubmixBase* SoundSubmix,
bool bInit
)

  
Public function Virtual void

RegisterSubmixBufferListener ( TSharedRef< ISubmixBufferListener, ESPMode::ThreadSafe > InSubmixBufferListener,
USoundSubmix& InSubmix
)

  
Public function Virtual void

RegisterSubmixBufferListener ( ISubmixBufferListener* InSubmixBufferListener,
USoundSubmix* InSubmix
)

 Submix buffer listener callbacks
Public function void

ReleaseMixerSourceVoice ( FMixerSourceVoice* InSourceVoice
)

  
Public function Virtual void

RemoveEnvelopeFollowerDelegate ( USoundSubmix* InSubmix,
const FOnSubmixEnvelopeBP& OnSubmixEnvelopeBP
)

  
Public function void

RemoveMainSubmixEffect ( uint32 SubmixEffectId
)

 Remove submix effect from main submix.
Public function void

RemoveMasterSubmixEffect ( uint32 SubmixEffectId
)

  
Public function Virtual void

RemoveSpectralAnalysisDelegate ( USoundSubmix* InSubmix,
const FOnSubmixSpectralAnalysisBP& OnSubmixSpectralAnalysisBP
)

  
Public function void

RemoveSubmixEffect ( USoundSubmix* InSoundSubmix,
uint32 SubmixEffectId
)

 Remove submix effect to given submix.
Public function void

RemoveSubmixEffectAtIndex ( USoundSubmix* InSoundSubmix,
int32 SubmixChainIndex
)

 Remove submix effect at the given submix chain index.
Public function void

ReplaceSoundEffectSubmix ( USoundSubmix* InSoundSubmix,
int32 InSubmixChainIndex,
FSoundEffectSubmixPtr SoundEffect
)

 Replace the submix effect of the given submix at the submix chain index with the new submix effect id and submix instance.
Public function Virtual void  
Public function Virtual void

ResumeRecording ( USoundSubmix* InSubmix
)

  
Public function Virtual void

SetSubmixAutoDisable ( USoundSubmix* InSoundSubmix,
bool bInAutoDisable
)

 Submix auto-disable setteings.
Public function Virtual void

SetSubmixAutoDisableTime ( USoundSubmix* InSoundSubmix,
float InDisableTime
)

  
Public function Virtual void

SetSubmixDryLevel ( USoundSubmix* InSoundSubmix,
float InDryLevel
)

  
Public function Virtual void

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

 Submix effect chain override settings.
Public function Virtual void

SetSubmixModulationBaseLevels ( USoundSubmix* InSoundSubmix,
float InVolumeModBase,
float InWetModBase,
float InDryModBase
)

  
Public function Virtual void

SetSubmixOutputVolume ( USoundSubmix* InSoundSubmix,
float InOutputVolume
)

  
Public function Virtual void

SetSubmixWetDryLevel ( USoundSubmix* InSoundSubmix,
float InOutputVolume,
float InWetLevel,
float InDryLevel
)

  
Public function Virtual void

SetSubmixWetLevel ( USoundSubmix* InSoundSubmix,
float InWetLevel
)

  
Public function Virtual void

StartEnvelopeFollowing ( USoundSubmix* InSubmix
)

 Submix envelope following.
Public function Virtual void

StartRecording ( USoundSubmix* InSubmix,
float ExpectedRecordingDuration
)

 Submix recording callbacks:
Public function Virtual void

StartSpectrumAnalysis ( USoundSubmix* InSubmix,
const FSoundSpectrumAnalyzerSettings& InSettings
)

 Submix Spectrum Analysis.
Public function Virtual void

StopEnvelopeFollowing ( USoundSubmix* InSubmix
)

  
Public function Virtual Audio::FAlignedFloatBuffer &

StopRecording ( USoundSubmix* InSubmix,
float& OutNumChannels,
float& OutSampleRate
)

  
Public function Virtual void

StopSpectrumAnalysis ( USoundSubmix* InSubmix
)

  
Public function Virtual Const bool  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

UnregisterSoundSubmix ( const USoundSubmixBase* SoundSubmix,
const bool bReparentChildren
)

  
Public function Virtual void

UnregisterSubmixBufferListener ( ISubmixBufferListener* InSubmixBufferListener,
USoundSubmix* InSubmix
)

  
Public function Virtual void

UnregisterSubmixBufferListener ( TSharedRef< ISubmixBufferListener, ESPMode::ThreadSafe > InSubmixBufferListener,
USoundSubmix& InSubmix
)

 This is optional, and should only be used to manually unregister before the ISubmixBufferListener is getting destroyed (do not call this in the destructor of ISubmixBufferListener or derived classes)
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

UpdateSourceEffectChain ( const uint32 SourceEffectChainId,
const TArray< FSourceEffectChainEntry >& SourceEffectChain,
const bool bPlayEffectChainTails
)

 Updates the source effect chain (using unique object id).
Public function Virtual void

UpdateSubmixModulationSettings ( USoundSubmix* InSoundSubmix,
const TSet< TObjectPtr< USoundModulatorBase > >& InOutputModulation,
const TSet< TObjectPtr< USoundModulatorBase > >& InWetLevelModulation,
const TSet< TObjectPtr< USoundModulatorBase > >& InDryLevelModulation
)

 Submix Modulation Settings.
Public function Virtual void

UpdateSubmixProperties ( USoundSubmixBase* InSubmix
)

 Submix dry/wet settings.
Public function Virtual bool

ValidateAPICall ( const TCHAR* Function,
uint32 ErrorCode
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page