UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::IAudioMixer Class Referenceabstract

#include <AudioMixer.h>

+ Inheritance diagram for Audio::IAudioMixer:

Public Member Functions

virtual bool OnProcessAudioStream (FAlignedFloatBuffer &OutputBuffer)=0
 
virtual void OnAudioStreamShutdown ()=0
 
bool IsMainAudioMixer () const
 

Static Public Member Functions

static AUDIOMIXERCORE_API bool ShouldUseThreadedDeviceSwap ()
 
static AUDIOMIXERCORE_API bool ShouldRecycleThreads ()
 
static AUDIOMIXERCORE_API bool ShouldUseDeviceInfoCache ()
 

Protected Member Functions

 IAudioMixer ()
 

Protected Attributes

bool bIsMainAudioMixer
 

Detailed Description

Platform independent audio mixer interface.

Constructor & Destructor Documentation

◆ IAudioMixer()

Audio::IAudioMixer::IAudioMixer ( )
inlineprotected

Member Function Documentation

◆ IsMainAudioMixer()

bool Audio::IAudioMixer::IsMainAudioMixer ( ) const
inline

◆ OnAudioStreamShutdown()

virtual void Audio::IAudioMixer::OnAudioStreamShutdown ( )
pure virtual

Called when audio render thread stream is shutting down. Last function called. Allows cleanup on render thread.

Implemented in Audio::FMixerDevice.

◆ OnProcessAudioStream()

virtual bool Audio::IAudioMixer::OnProcessAudioStream ( FAlignedFloatBuffer OutputBuffer)
pure virtual

Callback to generate a new audio stream buffer.

Implemented in Audio::FMixerDevice.

◆ ShouldRecycleThreads()

bool Audio::IAudioMixer::ShouldRecycleThreads ( )
static

Called by AudioMixer to see if it should reycle the threads:

◆ ShouldUseDeviceInfoCache()

bool Audio::IAudioMixer::ShouldUseDeviceInfoCache ( )
static

Called by AudioMixer if it should use Cache for DeviceInfo Enumeration

◆ ShouldUseThreadedDeviceSwap()

bool Audio::IAudioMixer::ShouldUseThreadedDeviceSwap ( )
static

Called by AudioMixer to see if we should do a multithreaded device swap

Member Data Documentation

◆ bIsMainAudioMixer

bool Audio::IAudioMixer::bIsMainAudioMixer
protected

The documentation for this class was generated from the following files: