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 > FMixerDevice

Light Theme

Dark Theme

FMixerDevice

Windows

MacOS

Linux

Inheritance Hierarchy

IAudioMixer

FMixerDevice

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

		Name	Description
	TArray< FTransf...	ListenerTransforms
	FQuartzClockMan...	QuantizedEventClockManager	Clock Manager for quantized event handling on Audio Render Thread.

Constructors

	Name	Description
	FMixerDevice ( IAudioMixerPlatformInterface* ... )

Destructors

	Name	Description
	~FMixerDevice()

Functions

	Name	Description
void	AddMasterSubmixEffect ( FSoundEffectSubmixPtr SoundEffect )	Add submix effect to master submix.
FPatchOutput...	AddPatchForAudioBus ( uint32 InAudioBusId, float InPatchGain )
int32	AddSubmixEffect ( USoundSubmix* InSoundSubmix, FSoundEffectSubmixPtr SoundEffect )	Add submix effect to given submix.
void	AudioRenderThreadCommand ( TFunction< void()> Command )	Pushes the command to a audio render thread command queue to be executed on render thread.
void	CheckAudioRenderingThread()
void	CheckAudioThread()	Functions which check the thread it's called on and helps make sure functions are called from correct threads.
void	ClearMasterSubmixEffects()	Clear all submix effects from master submix.
void	ClearSubmixEffects ( USoundSubmix* InSoundSubmix )	Clear all submix effects from given submix.
FMixerSubmix...	FindSubmixInstanceByObjectId ( uint32 InObjectId )
void	Get2DChannelMap ( bool bIsVorbis, const int32 NumSourceChannels, const bool bIsCenterChannelOnly, Audio::AlignedFloatBuffer& OutChan... )	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.
void	Get2DChannelMap ( bool bIsVorbis, const int32 NumSourceChannels, const int32 NumOutputChannels, const bool bIsCenterChannelOnly, Audio::AlignedFloatBuffer& OutChan... )	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.
void	Get3DChannelMap ( const int32 InSubmixNumChannels, const FWaveInstance* InWaveIns..., const float EmitterAzimuth, const float NormalizedOmniRadius, Audio::AlignedFloatBuffer& OutChan... )	Builds a 3D channel map for a spatialized source.
double	GetAudioClockDelta()
IAudioMixerP...	GetAudioMixerPlatform()	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.
double	GetAudioRenderThreadTime()
double	GetAudioThreadTime()	Audio thread tick timing relative to audio render thread timing.
FMixerSubmix...	GetBaseDefaultSubmix()
const TArray...	GetChannelArray()	Returns the channel array for the given submix channel type.
const FChann...	GetDefaultChannelPositions()	Retrieves spherical locations of channels for a given submix format.
TArray< Audi...	GetDefaultPositionMap ( int32 NumChannels )
int32	GetDeviceOutputChannels()
int32	GetDeviceSampleRate()
ISoundfieldF...	GetFactoryForSubmixInstance ( USoundSubmix* SoundSubmix )	If SoundSubmix is a soundfield submix, this will return the factory used to encode source audio to it's soundfield format.
ISoundfieldF...	GetFactoryForSubmixInstance ( FMixerSubmixWeakPtr& SoundSubmixPt... )	If SoundSubmix is a soundfield submix, this will return the factory used to encode source audio to it's soundfield format.
const TArray...	GetListenerTransforms()	Retrieves the listener transforms.
FMixerSubmix...	GetMasterEQSubmix()
FMixerSubmix...	GetMasterReverbSubmix()
FMixerSubmix...	GetMasterSubmix()
FMixerSource...	GetMixerSourceVoice()	Public Functions.
EMonoChannel...	GetMonoChannelUpmixMethod()
int32	GetNumDeviceChannels()
int32	GetNumOutputFrames()
int32	GetNumSources()
const FAudio...	GetPlatformDeviceInfo()
FMixerSource...	GetSourceManager()
FMixerSubmix...	GetSubmixInstance ( const USoundSubmixBase* SoundS... )
bool	IsAudioBusActive ( uint32 InAudioBusId )
bool	IsAudioRenderingThread()
bool	IsEndpointSubmix ( const USoundSubmixBase* InSubm... )
void	PauseRecording ( USoundSubmix* InSubmix )
void	ReleaseMixerSourceVoice ( FMixerSourceVoice* InSourceVoi... )
void	RemoveMasterSubmixEffect ( uint32 SubmixEffectId )	Remove submix effect from master submix.
void	RemoveSubmixEffect ( USoundSubmix* InSoundSubmix, uint32 SubmixEffectId )	Remove submix effect to given submix.
void	RemoveSubmixEffectAtIndex ( USoundSubmix* InSoundSubmix, int32 SubmixChainIndex )	Remove submix effect at the given submix chain index.
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.
void	ResumeRecording ( USoundSubmix* InSubmix )
void	StartAudioBus ( uint32 InAudioBusId, int32 InNumChannels, bool bInIsAutomatic )	Audio bus API.
void	StopAudioBus ( uint32 InAudioBusId )

Overridden from FAudioDevice

	Name	Description
void	AddEnvelopeFollowerDelegate ( USoundSubmix* InSubmix, const FOnSubmixEnvelopeBP& OnSubmi... )	Adds an envelope follower delegate to the submix for this audio device.
FPatchOutput...	AddPatchForSubmix ( uint32 InObjectId, float InPatchGain )
void	AddSpectralAnalysisDelegate ( USoundSubmix* InSubmix, const FSoundSpectrumAnalyzerDelegat..., const FOnSubmixSpectralAnalysisBP&... )
void	ClearSubmixEffectChainOverride ( USoundSubmix* InSoundSubmix, float InCrossfadeTime )	Clears all submix effect chain overrides from the submix.
void	CountBytes ( FArchive& Ar )	Counts the bytes for the structures used in this class
ICompressedA...	CreateCompressedAudioInfo ( USoundWave* SoundWave )	Creates a Compressed audio info class suitable for decompressing this SoundWave
FAudioEffect...	CreateEffectsManager()	Creates a new platform specific sound source
FSoundSource...	CreateSoundSource()	Creates a new platform specific sound source
bool	DisablePCMAudioCaching()	Whether or not the platform disables caching of decompressed PCM data (i.e. to save memory on fixed memory platforms
void	EnableDebugAudioOutput()	Enables the audio device to output debug audio to test audio device output.
void	FadeIn()
void	FadeOut()	Optional fadeout and fade in of audio to avoid clicks when closing or opening/reusing audio device.
void	FlushAudioRenderingCommands ( bool bPumpSynchronously )	Allows audio rendering command queue to flush during audio device flush.
void	FlushExtended ( UWorld* WorldToFlush, bool bClearActivatedReverb )	Derived classes can override this method to do their own cleanup.
void	GetAudioDeviceList ( TArray< FString >& OutAudioDeviceN... )	Returns an array of available audio devices names for the platform
double	GetAudioTime()	Return the audio stream time
bool	GetCurrentSourceEffectChain ( const uint32 SourceEffectChainId, TArray< FSourceEffectChainEntry >&... )	Returns the current source effect chain entries set dynamically from BP or elsewhere.
void	GetMagnitudesForFrequencies ( USoundSubmix* InSubmix, const TArray< float >& InFrequenci..., TArray< float >& OutMagnitudes )
int32	GetNumActiveSources()	Returns the number of active sound sources
void	GetPhasesForFrequencies ( USoundSubmix* InSubmix, const TArray< float >& InFrequenci..., TArray< float >& OutPhases )
FAudioPlatfo...	GetPlatformSettings()	Allow platforms to optionally specify low-level audio platform settings.
FName	GetRuntimeFormat ( USoundWave* SoundWave )
bool	HasCompressedAudioInfoClass ( USoundWave* SoundWave )	Whether this SoundWave has an associated info class to decompress it
void	InitDefaultAudioBuses()	Initialized audio buses marked as default that are to be enabled for the duration of the application.
bool	InitializeHardware()	Starts up any platform specific hardware/APIs
void	InitSoundEffectPresets()
void	InitSoundSubmixes()	Initializes sound submixes.
bool	IsExernalBackgroundSoundActive()	Check if any background music or sound is playing through the audio device
bool	IsNonRealtime()	Audio Device Properties.
void	OnListenerUpdated ( const TArray< FListener >& InListe... )	This is overridden in Audio::FMixerDevice to propogate listener information to the audio thread.
void	RegisterSoundSubmix ( USoundSubmixBase* SoundSubmix, bool bInit )	Registers the sound submix
void	RegisterSubmixBufferListener ( ISubmixBufferListener* InSubmi..., USoundSubmix* InSubmix )	Submix buffer listener callbacks.
void	RemoveSpectralAnalysisDelegate ( USoundSubmix* InSubmix, const FOnSubmixSpectralAnalysisBP&... )
void	ResumeContext()	Resume any context related objects
void	SetSubmixDryLevel ( USoundSubmix* InSoundSubmix, float InDryLevel )	Set the wet-dry level of the given submix
void	SetSubmixEffectChainOverride ( USoundSubmix* InSoundSubmix, const TArray< FSoundEffectSubmixPtr..., float InFadeTimeSec )	Submix effect chain override settings.
void	SetSubmixOutputVolume ( USoundSubmix* InSoundSubmix, float InOutputVolume )	Set the wet-dry level of the given submix
void	SetSubmixWetDryLevel ( USoundSubmix* InSoundSubmix, float InOutputVolume, float InWetLevel, float InDryLevel )	Set the wet-dry level of the given submix
void	SetSubmixWetLevel ( USoundSubmix* InSoundSubmix, float InWetLevel )	Set the wet-dry level of the given submix
void	ShutdownDefaultAudioBuses()	Shutdown all audio buses marked as default.
void	StartEnvelopeFollowing ( USoundSubmix* InSubmix )	Submix envelope following.
void	StartRecording ( USoundSubmix* InSubmix, float ExpectedRecordingDuration )	Submix recording callbacks:
void	StartSpectrumAnalysis ( USoundSubmix* InSubmix, const FSoundSpectrumAnalyzerSetting... )	Submix Spectrum Analysis.
void	StopEnvelopeFollowing ( USoundSubmix* InSubmix )	This is called by a USoundSubmix when we stop envelope following a submix instance on this device.
Audio::Align...	StopRecording ( USoundSubmix* InSubmix, float& OutNumChannels, float& OutSampleRate )	This is called by a USoundSubmix when we stop recording a submix on this device.
void	StopSpectrumAnalysis ( USoundSubmix* InSubmix )
bool	SupportsRealtimeDecompression()	Whether this device supports realtime decompression of sound waves (i.e. DTYPE_RealTime)
void	SuspendContext()	Suspend any context related objects
void	TeardownHardware()	Shuts down any platform specific hardware/APIs
void	UnregisterSoundSubmix ( const USoundSubmixBase* SoundS... )	Unregisters the sound submix
void	UnregisterSubmixBufferListener ( ISubmixBufferListener* InSubmi..., USoundSubmix* SoundSubmix )	Unregisters the submix buffer listener with the given submix.
void	UpdateDeviceDeltaTime()	Sets the update delta time for the audio frame
void	UpdateGameThread()	Update called on game thread.
void	UpdateHardware()	Lets the platform any tick actions
void	UpdateHardwareTiming()	Updates timing information for hardware.
void	UpdateSourceEffectChain ( const uint32 SourceEffectChainId, const TArray< FSourceEffectChainEnt..., const bool bPlayEffectChainTails )	Updates the source effect chain (using unique object id).
void	UpdateSubmixProperties ( USoundSubmixBase* InSubmix )	Submix dry/wet settings.
bool	ValidateAPICall ( const TCHAR* Function, uint32 ErrorCode )	Check for errors and output a human readable string

Overridden from FExec

		Name	Description
	bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )	Exec handler

Overridden from IAudioMixer

		Name	Description
	void	OnAudioStreamShutdown()	Called when audio render thread stream is shutting down.
	bool	OnProcessAudioStream ( AlignedFloatBuffer& OutputBuffer )	Callback to generate a new audio stream buffer.

Overridden from FGCObject

		Name	Description
	void	AddReferencedObjects ( FReferenceCollector& Collector )	Pure virtual that must be overloaded by the inheriting class.

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

Take our survey

Dismiss