UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
AudioMixerBlueprintLibrary.h File Reference
#include "CoreMinimal.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h"
#include "Sound/SoundEffectSource.h"
#include "Sound/AudioBus.h"
#include "SampleBuffer.h"
#include "Sound/SoundCue.h"
#include "Sound/SoundSubmixSend.h"
#include "DSP/SpectrumAnalyzer.h"
#include "AudioMixer.h"
#include "AudioMixerTypes.h"
#include "AudioMixerBlueprintLibrary.generated.h"

Go to the source code of this file.

Classes

struct  FSwapAudioOutputResult
 
struct  FAudioOutputDeviceInfo
 
class  UAudioMixerBlueprintLibrary
 

Enumerations

enum class  EMusicalNoteName : uint8 {
  C = 0 , Db = 1 , D = 2 , Eb = 3 ,
  E = 4 , F = 5 , Gb = 6 , G = 7 ,
  Ab = 8 , A = 9 , Bb = 10 , B = 11
}
 
enum class  EAudioMixerStreamDataFormatType : uint8 { Unknown , Float , Int16 , Unsupported }
 
enum class  EAudioMixerChannelType : uint8 {
  FrontLeft , FrontRight , FrontCenter , LowFrequency ,
  BackLeft , BackRight , FrontLeftOfCenter , FrontRightOfCenter ,
  BackCenter , SideLeft , SideRight , TopCenter ,
  TopFrontLeft , TopFrontCenter , TopFrontRight , TopBackLeft ,
  TopBackCenter , TopBackRight , Unknown , ChannelTypeCount ,
  DefaultChannel = FrontLeft
}
 
enum class  ESwapAudioOutputDeviceResultState : uint8 { Failure , Success , None }
 

Functions

 DECLARE_DYNAMIC_DELEGATE_TwoParams (FOnSoundLoadComplete, const class USoundWave *, LoadedSoundWave, const bool, WasCancelled)
 
FString DataFormatAsString (EAudioMixerStreamDataFormatType type)
 
const TCHARToString (EAudioMixerChannelType InType)
 
 DECLARE_DYNAMIC_DELEGATE_OneParam (FOnAudioOutputDevicesObtained, const TArray< FAudioOutputDeviceInfo > &, AvailableDevices)
 
 DECLARE_DYNAMIC_DELEGATE_OneParam (FOnMainAudioOutputDeviceObtained, const FString &, CurrentDevice)
 
 DECLARE_DYNAMIC_DELEGATE_OneParam (FOnCompletedDeviceSwap, const FSwapAudioOutputResult &, SwapResult)
 

Enumeration Type Documentation

◆ EAudioMixerChannelType

Enumerator
FrontLeft 
FrontRight 
FrontCenter 
LowFrequency 
BackLeft 
BackRight 
FrontLeftOfCenter 
FrontRightOfCenter 
BackCenter 
SideLeft 
SideRight 
TopCenter 
TopFrontLeft 
TopFrontCenter 
TopFrontRight 
TopBackLeft 
TopBackCenter 
TopBackRight 
Unknown 
ChannelTypeCount 
DefaultChannel 

◆ EAudioMixerStreamDataFormatType

Enumerator
Unknown 
Float 
Int16 
Unsupported 

◆ EMusicalNoteName

enum class EMusicalNoteName : uint8
strong
Enumerator
Db 
Eb 
Gb 
Ab 
Bb 

◆ ESwapAudioOutputDeviceResultState

Enumerator
Failure 
Success 
None 

Function Documentation

◆ DataFormatAsString()

FString DataFormatAsString ( EAudioMixerStreamDataFormatType  type)

◆ DECLARE_DYNAMIC_DELEGATE_OneParam() [1/3]

DECLARE_DYNAMIC_DELEGATE_OneParam ( FOnAudioOutputDevicesObtained  ,
const TArray< FAudioOutputDeviceInfo > &  ,
AvailableDevices   
)

Called when a list of all available audio devices is retrieved

◆ DECLARE_DYNAMIC_DELEGATE_OneParam() [2/3]

DECLARE_DYNAMIC_DELEGATE_OneParam ( FOnCompletedDeviceSwap  ,
const FSwapAudioOutputResult ,
SwapResult   
)

Called when the system has swapped to another audio output device

◆ DECLARE_DYNAMIC_DELEGATE_OneParam() [3/3]

DECLARE_DYNAMIC_DELEGATE_OneParam ( FOnMainAudioOutputDeviceObtained  ,
const FString &  ,
CurrentDevice   
)

Called when a list of all available audio devices is retrieved

◆ DECLARE_DYNAMIC_DELEGATE_TwoParams()

DECLARE_DYNAMIC_DELEGATE_TwoParams ( FOnSoundLoadComplete  ,
const class USoundWave ,
LoadedSoundWave  ,
const bool  ,
WasCancelled   
)

Called when a load request for a sound has completed.

◆ ToString()

const TCHAR * ToString ( EAudioMixerChannelType  InType)
inline