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

#include <AudioMixer.h>

+ Inheritance diagram for Audio::IAudioMixerDeviceChangedListener:

Classes

struct  FFormatChangedData
 

Public Types

enum class  EDisconnectReason {
  DeviceRemoval , ServerShutdown , FormatChanged , SessionLogoff ,
  SessionDisconnected , ExclusiveModeOverride
}
 

Public Member Functions

virtual ~IAudioMixerDeviceChangedListener ()=default
 
virtual void RegisterDeviceChangedListener ()
 
virtual void UnregisterDeviceChangedListener ()
 
virtual void OnDefaultCaptureDeviceChanged (const EAudioDeviceRole InAudioDeviceRole, const FString &DeviceId)
 
virtual void OnDefaultRenderDeviceChanged (const EAudioDeviceRole InAudioDeviceRole, const FString &DeviceId)
 
virtual void OnDeviceAdded (const FString &DeviceId, bool bIsRenderDevice)
 
virtual void OnDeviceRemoved (const FString &DeviceId, bool bIsRenderDevice)
 
virtual void OnDeviceStateChanged (const FString &DeviceId, const EAudioDeviceState InState, bool bIsRenderDevice)
 
virtual void OnFormatChanged (const FString &InDeviceId, const FFormatChangedData &InFormat)
 
virtual void OnSessionDisconnect (EDisconnectReason InReason)
 
virtual FString GetDeviceId () const
 

Detailed Description

Abstract interface for receiving audio device changed notifications

Member Enumeration Documentation

◆ EDisconnectReason

Enumerator
DeviceRemoval 
ServerShutdown 
FormatChanged 
SessionLogoff 
SessionDisconnected 
ExclusiveModeOverride 

Constructor & Destructor Documentation

◆ ~IAudioMixerDeviceChangedListener()

virtual Audio::IAudioMixerDeviceChangedListener::~IAudioMixerDeviceChangedListener ( )
virtualdefault

Member Function Documentation

◆ GetDeviceId()

virtual FString Audio::IAudioMixerDeviceChangedListener::GetDeviceId ( ) const
inlinevirtual

◆ OnDefaultCaptureDeviceChanged()

virtual void Audio::IAudioMixerDeviceChangedListener::OnDefaultCaptureDeviceChanged ( const EAudioDeviceRole  InAudioDeviceRole,
const FString &  DeviceId 
)
inlinevirtual

◆ OnDefaultRenderDeviceChanged()

virtual void Audio::IAudioMixerDeviceChangedListener::OnDefaultRenderDeviceChanged ( const EAudioDeviceRole  InAudioDeviceRole,
const FString &  DeviceId 
)
inlinevirtual

◆ OnDeviceAdded()

virtual void Audio::IAudioMixerDeviceChangedListener::OnDeviceAdded ( const FString &  DeviceId,
bool  bIsRenderDevice 
)
inlinevirtual

◆ OnDeviceRemoved()

virtual void Audio::IAudioMixerDeviceChangedListener::OnDeviceRemoved ( const FString &  DeviceId,
bool  bIsRenderDevice 
)
inlinevirtual

◆ OnDeviceStateChanged()

virtual void Audio::IAudioMixerDeviceChangedListener::OnDeviceStateChanged ( const FString &  DeviceId,
const EAudioDeviceState  InState,
bool  bIsRenderDevice 
)
inlinevirtual

◆ OnFormatChanged()

virtual void Audio::IAudioMixerDeviceChangedListener::OnFormatChanged ( const FString &  InDeviceId,
const FFormatChangedData InFormat 
)
inlinevirtual

◆ OnSessionDisconnect()

virtual void Audio::IAudioMixerDeviceChangedListener::OnSessionDisconnect ( EDisconnectReason  InReason)
inlinevirtual

◆ RegisterDeviceChangedListener()

virtual void Audio::IAudioMixerDeviceChangedListener::RegisterDeviceChangedListener ( )
inlinevirtual

◆ UnregisterDeviceChangedListener()

virtual void Audio::IAudioMixerDeviceChangedListener::UnregisterDeviceChangedListener ( )
inlinevirtual

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