1. Epic GamesDeveloper
  3. FMixerDevice

FMixerDevice

Unreal Engine C++ API Reference > Runtime > AudioMixer

Inheritance Hierarchy

References

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

Syntax

class FMixerDevice :  
    public FAudioDevice,  
    public Audio::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 void

AddMasterSubmixEffect ( FSoundEffectSubmixPtr SoundEffect
)

 Add submix effect to master submix.
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 master submix.
Public function void

ClearSubmixEffects ( USoundSubmix* InSoundSubmix
)

 Clear all submix effects from given submix.
Public function Static void 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 FMixerSubmixPtr

FindSubmixInstanceByObjectId ( uint32 InObjectId
)

  
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
)

 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 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 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 FMixerSubmixWeakPtr  
Public function Const const TArray< EAudioMixerChannel::Type > & Returns the channel array for the given submix channel type.
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 ISoundfieldFactory * If SoundSubmix is a soundfield submix, this will return the factory used to encode source audio to it's soundfield format.
Public function ISoundfieldFactory * If SoundSubmix is a soundfield submix, this will return the factory used to encode source audio to it's soundfield format.
Public function const TArray< FTransform > * Retrieves the listener transforms.
Public function FMixerSubmixWeakPtr  
Public function FMixerSubmixWeakPtr  
Public function FMixerSubmixWeakPtr  
Public function FMixerSourceVoice * Public Functions.
Public function Const EMonoChannelUpmixMethod  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const const FAudioPlatformDeviceInfo &  
Public function Const const FMixerSourceManager *  
Public function FMixerSourceManager *  
Public function FMixerSubmixWeakPtr

GetSubmixInstance ( const USoundSubmixBase* SoundSubmix
)

  
Public function Const bool  
Public function Static bool

IsEndpointSubmix ( const USoundSubmixBase* InSubmix
)

  
Public function Static int "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  
Public function void

ReleaseMixerSourceVoice ( FMixerSourceVoice* InSourceVoice
)

  
Public function void

RemoveMasterSubmixEffect ( uint32 SubmixEffectId
)

 Remove submix effect from master submix.
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  

Overridden from FAudioDevice

  Type Name Description
Public function Virtual void

AddEnvelopeFollowerDelegate ( USoundSubmix* InSubmix,
const FOnSubmixEnvelopeBP& OnSubmixEnvelopeBP
)

 Adds an envelope follower delegate to the submix for this audio device.
Public function Virtual FPatchOutputStrongPtr

AddPatchForSubmix ( uint32 InObjectId,
float InPatchGain
)

  
Public function Virtual void

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

  
Public function Virtual void

ClearSubmixEffectChainOverride ( USoundSubmix* InSoundSubmix,
float InCrossfadeTime
)

 Clears all submix effect chain overrides from the submix.
Public function Virtual void Counts the bytes for the structures used in this class
Public function Virtual FAudioEffectsManager * Creates a new platform specific sound source
Public function Virtual FSoundSource * Creates a new platform specific sound source
Public function Virtual Const bool Whether or not the platform disables caching of decompressed PCM data (i.e. to save memory on fixed memory platforms
Public function Virtual void Enables the audio device to output debug audio to test audio device output.
Public function Virtual void

FadeIn ()

  
Public function Virtual void

FadeOut ()

 Optional fadeout and fade in of audio to avoid clicks when closing or opening/reusing audio device.
Public function Virtual void

FlushAudioRenderingCommands ( bool bPumpSynchronously
)

 Allows audio rendering command queue to flush during audio device flush.
Public function Virtual void

FlushExtended ( UWorld* WorldToFlush,
bool bClearActivatedReverb
)

 Derived classes can override this method to do their own cleanup.
Public function Virtual Const void

GetAudioDeviceList ( TArray< FString >& OutAudioDeviceNames
)

 Returns an array of available audio devices names for the platform
Public function Virtual Const double Return the audio stream time
Public function Virtual bool

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

 Returns the current source effect chain entries set dynamically from BP or elsewhere.
Public function Virtual void

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

  
Public function Virtual Const int32 Returns the number of active sound sources
Public function Virtual void

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

  
Public function Virtual Const FAudioPlatformSettings Allow platforms to optionally specify low-level audio platform settings.
Public function Virtual bool Whether this SoundWave has an associated info class to decompress it
Public function Virtual bool Starts up any platform specific hardware/APIs
Public function Virtual void  
Protected function Virtual void Initializes sound submixes.
Public function Virtual bool Check if any background music or sound is playing through the audio device
Public function Virtual Const bool Audio Device Properties.
Protected function Virtual void

OnListenerUpdated ( const TArray< FListener >& InListeners
)

 This is overridden in Audio::FMixerDevice to propogate listener information to the audio thread.
Public function Virtual void

RegisterSoundSubmix ( USoundSubmixBase* SoundSubmix,
bool bInit
)

 Registers the sound submix
Public function Virtual void

RegisterSubmixBufferListener ( ISubmixBufferListener* InSubmixBufferListener,
USoundSubmix* InSubmix
)

 Submix buffer listener callbacks.
Public function Virtual void

RemoveSpectralAnalysisDelegate ( USoundSubmix* InSubmix,
const FOnSubmixSpectralAnalysisBP& OnSubmixSpectralAnalysisBP
)

  
Public function Virtual void Resume any context related objects
Public function Virtual void

SetSubmixAutoDisable ( USoundSubmix* InSoundSubmix,
bool bInAutoDisable
)

 Submix auto-disable setteings.
Public function Virtual void

SetSubmixAutoDisableTime ( USoundSubmix* InSoundSubmix,
float InDisableTime
)

 Set what the auto-disable time is.
Public function Virtual void

SetSubmixDryLevel ( USoundSubmix* InSoundSubmix,
float InDryLevel
)

 Set the wet-dry level of the given submix
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
)

 Set the wet-dry level of the given submix
Public function Virtual void

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

 Set the wet-dry level of the given submix
Public function Virtual void

SetSubmixWetLevel ( USoundSubmix* InSoundSubmix,
float InWetLevel
)

 Set the wet-dry level of the given submix
Public function Virtual void Submix envelope following.
Public function Virtual void

StartRecording ( USoundSubmix* InSubmix,
float ExpectedRecordingDuration
)

 Submix recording callbacks:
Public function Virtual void Submix Spectrum Analysis.
Public function Virtual void This is called by a USoundSubmix when we stop envelope following a submix instance on this device.
Public function Virtual Audio::FAlignedFloatBuffer &

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

 This is called by a USoundSubmix when we stop recording a submix on this device.
Public function Virtual void  
Public function Virtual Const bool Whether this device supports realtime decompression of sound waves (i.e. DTYPE_RealTime)
Public function Virtual void Suspend any context related objects
Public function Virtual void Shuts down any platform specific hardware/APIs
Public function Virtual void

UnregisterSoundSubmix ( const USoundSubmixBase* SoundSubmix
)

 Unregisters the sound submix
Public function Virtual void

UnregisterSubmixBufferListener ( ISubmixBufferListener* InSubmixBufferListener,
USoundSubmix* SoundSubmix
)

 Unregisters the submix buffer listener with the given submix.
Public function Virtual void Sets the update delta time for the audio frame
Public function Virtual void Update called on game thread.
Public function Virtual void Lets the platform any tick actions
Public function Virtual void Updates timing information for hardware.
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 Submix dry/wet settings.
Public function Virtual bool

ValidateAPICall ( const TCHAR* Function,
uint32 ErrorCode
)

 Check for errors and output a human readable string

Overridden from IAudioMixer

  Type Name Description
Public function Virtual void Called when audio render thread stream is shutting down.
Public function Virtual bool Callback to generate a new audio stream buffer.

Overridden from FGCObject

  Type Name Description
Public function Virtual void Pure virtual that must be overloaded by the inheriting class.
Public function Virtual Const FString Overload this method to report a name for your referencer

Deprecated Functions

  Type Name Description
Public function Virtual FPatchOutputStrongPtr

AddPatchForAudioBus ( uint32 InAudioBusId,
float InPatchGain
)

 AddPatchForAudioBus is deprecated. Use UAudioBusSubsystem::AddPatchOutputForAudioBus.
Public function Virtual FPatchOutputStrongPtr

AddPatchForAudioBus_GameThread ( uint32 InAudioBusId,
float InPatchGain
)

 AddPatchForAudioBus_GameThread is deprecated. Use UAudioBusSubsystem::AddPatchOutputForAudioBus.
Public function Virtual void

AddPatchInputForAudioBus ( const FPatchInput& InPatchInput,
uint32 InAudioBusId,
float InPatchGain
)

 This overload of AddPatchInputForAudioBus is deprecated and non-functional. Use the overload that takes the number of frames and channels as parameters.
Public function Virtual void

AddPatchInputForAudioBus_GameThread ( const FPatchInput& InPatchInput,
uint32 InAudioBusId,
float InPatchGain
)

 AddPatchInputForAudioBus_GameThread is deprecated. Use UAudioBusSubsystem::AddPatchInputForAudioBus.
Public function Virtual Const ICompressedAudioInfo * CreateCompressedAudioInfo is now deprecated. Please use IAudioInfoFactory::Create() instead
Public function Virtual Const ICompressedAudioInfo *

CreateCompressedAudioInfo ( const USoundWave* SoundWave
)

 CreateCompressedAudioInfo is now deprecated. Please use IAudioInfoFactory::Create() instead
Public function Virtual Const FName

GetRuntimeFormat ( const USoundWave* SoundWave
)

 GetRuntimeFormat is now deprecated. Please call SoundWave::GetRuntimeFormat() instead
Public function Virtual void The functionality for this has been moved to UAudioBusSubsystem::InitDefaultAudioBuses, which is now automatically called on subsystem creation.
Public function Virtual Const bool

IsAudioBusActive ( uint32 InAudioBusId
)

 This function is deprecated. Use UAudioBusSubsystem::IsAudioBusActive instead.
Public function Virtual void The functionality for this has been moved to UAudioBusSubsystem::ShutdownDefaultAudioBuses.
Public function Virtual void

StartAudioBus ( uint32 InAudioBusId,
int32 InNumChannels,
bool bInIsAutomatic
)

 This function is deprecated. Use UAudioBusSubsystem::StartAudioBus instead.
Public function Virtual void

StopAudioBus ( uint32 InAudioBusId
)

 This function is deprecated. Use UAudioBusSubsystem::StopAudioBus instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page