1. Epic GamesDeveloper
  3. UAudioMixerBlueprintLibrary

UAudioMixerBlueprintLibrary

API > API/Runtime > API/Runtime/AudioMixer

   
Name UAudioMixerBlueprintLibrary
Type class
Header File /Engine/Source/Runtime/AudioMixer/Public/AudioMixerBlueprintLibrary.h
Include Path #include "AudioMixerBlueprintLibrary.h"

Syntax

UCLASS (Meta=(ScriptName="AudioMixerLibrary"), MinimalAPI)  
class UAudioMixerBlueprintLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void AddMasterSubmixEffect ( const UObject* WorldContextObject,
USoundEffectSubmixPreset* SubmixEffectPreset
)

 Adds a submix effect preset to the master submix. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject")

static void AddSourceEffectToPresetChain ( const UObject* WorldContextObject,
USoundEffectSourcePresetChain* PresetChain,
FSourceEffectChainEntry Entry
)

 Adds source effect entry to preset chain. Only effects the instance of the preset chain AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject")

static int32 AddSubmixEffect ( const UObject* WorldContextObject,
USoundSubmix* SoundSubmix,
USoundEffectSubmixPreset* SubmixEffectPreset
)

 Adds a submix effect preset to the given submix at the end of its submix effect chain. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject")

static void ClearMasterSubmixEffects ( const UObject* WorldContextObject
)

 Clears all master submix effects. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject")

static void ClearSubmixEffectChainOverride ( const UObject* WorldContextObject,
USoundSubmix* SoundSubmix,
float FadeTimeSec
)

 Clears all submix effect overrides on the given submix and returns it to the default effect chain. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject")

static void ClearSubmixEffects ( const UObject* WorldContextObject,
USoundSubmix* SoundSubmix
)

 Clears all submix effects on the given submix. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject")

static FString Conv_AudioOutputDeviceInfoToString ( const FAudioOutputDeviceInfo& Info
)

 Returns the device info in a human readable format AudioMixerBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Audio Output Device Info To String", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Audio"

static void GetAvailableAudioOutputDevices ( const UObject* WorldContextObject,
const FOnAudioOutputDevicesObtained& OnObtainDevicesEvent
)

 Gets information about all audio output devices available in the system AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio"
  • Meta=(WorldContext="WorldContextObject")

static void GetCurrentAudioOutputDeviceName ( const UObject* WorldContextObject,
const FOnMainAudioOutputDeviceObtained& OnObtainCurrentDeviceEvent
)

 Gets information about the currently used audio output device AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio"
  • Meta=(WorldContext="WorldContextObject")

static void GetMagnitudeForFrequencies ( const UObject* WorldContextObject,
const TArray< float >& Frequencies,
TArray< float >& Magnitudes,
USoundSubmix* SubmixToAnalyze
)

 Retrieve the magnitudes for the given frequencies. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Analysis"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay=3)

static int32 GetNumberOfEntriesInSourceEffectChain ( const UObject* WorldContextObject,
USoundEffectSourcePresetChain* PresetChain
)

 Returns the number of effect chain entries in the given source effect chain. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject")

static void GetPhaseForFrequencies ( const UObject* WorldContextObject,
const TArray< float >& Frequencies,
TArray< float >& Phases,
USoundSubmix* SubmixToAnalyze
)

 Retrieve the phases for the given frequencies. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Analysis"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay=3)

static bool IsAudioBusActive ( const UObject* WorldContextObject,
UAudioBus* AudioBus
)

 Queries if the given audio bus is active (and audio can be mixed to it). AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Bus"
  • Meta=(WorldContext="WorldContextObject")

static TArray< FSoundSubmixSpectralAnalysisBandSettings > MakeFullSpectrumSpectralAnalysisBandSettings ( int32 InNumBands,
float InMinimumFrequency,
float InMaximumFrequency,
int32 InAttackTimeMsec,
int32 InReleaseTimeMsec
)

 Make an array of logarithmically spaced bands. AudioMixerBlueprintLibrary.h
  • BlueprintPure
  • Category="Audio|Analysis"
  • Meta=(AdvancedDisplay=3)

static TArray< FSoundSubmixSpectralAnalysisBandSettings > MakeMusicalSpectralAnalysisBandSettings ( int32 InNumSemitones,
EMusicalNoteName InStartingMusicalNote,
int32 InStartingOctave,
int32 InAttackTimeMsec,
int32 InReleaseTimeMsec
)

 Make an array of musically spaced bands with ascending frequency. AudioMixerBlueprintLibrary.h
  • BlueprintPure
  • Category="Audio|Analysis"
  • Meta=(AdvancedDisplay=3)

static TArray< FSoundSubmixSpectralAnalysisBandSettings > MakePresetSpectralAnalysisBandSettings ( EAudioSpectrumBandPresetType InBandPresetType,
int32 InNumBands,
int32 InAttackTimeMsec,
int32 InReleaseTimeMsec
)

 Make an array of bands which span the frequency range of a given EAudioSpectrumBandPresetType. AudioMixerBlueprintLibrary.h
  • BlueprintPure
  • Category="Audio|Analysis"
  • Meta=(AdvancedDisplay=2)

static void PauseRecordingOutput ( const UObject* WorldContextObject,
USoundSubmix* SubmixToPause
)

 Pause recording audio, without finalizing the recording to disk. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Recording"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay=1)

static void PrimeSoundCueForPlayback ( USoundCue* SoundCue
)

 Begin loading any sounds referenced by a sound cue into the cache so that it can be played immediately. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Cache"

static void PrimeSoundForPlayback ( USoundWave* SoundWave,
const FOnSoundLoadComplete OnLoadCompletion
)

 Begin loading a sound into the cache so that it can be played immediately. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Cache"

static void RegisterAudioBusToSubmix ( const UObject* WorldContextObject,
USoundSubmix* SoundSubmix,
UAudioBus* AudioBus
)

 Registers an audio bus to a submix so the submix output can be routed to the audiobus. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Bus"
  • Meta=(WorldContext="WorldContextObject")

static void RemoveMasterSubmixEffect ( const UObject* WorldContextObject,
USoundEffectSubmixPreset* SubmixEffectPreset
)

 Removes a submix effect preset from the master submix. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject")

static void RemoveSourceEffectFromPresetChain ( const UObject* WorldContextObject,
USoundEffectSourcePresetChain* PresetChain,
int32 EntryIndex
)

 Removes source effect entry from preset chain. Only affects the instance of preset chain. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject")

static void RemoveSubmixEffect ( const UObject* WorldContextObject,
USoundSubmix* SoundSubmix,
USoundEffectSubmixPreset* SubmixEffectPreset
)

 Removes all instances of a submix effect preset from the given submix. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject")

static void RemoveSubmixEffectAtIndex ( const UObject* WorldContextObject,
USoundSubmix* SoundSubmix,
int32 SubmixChainIndex
)

 Removes the submix effect at the given submix chain index, if there is a submix effect at that index. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject")

static void RemoveSubmixEffectPreset ( const UObject* WorldContextObject,
USoundSubmix* SoundSubmix,
USoundEffectSubmixPreset* SubmixEffectPreset
)

   AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject", DeprecatedFunction)

static void RemoveSubmixEffectPresetAtIndex ( const UObject* WorldContextObject,
USoundSubmix* SoundSubmix,
int32 SubmixChainIndex
)

   AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject", DeprecatedFunction)

static void ReplaceSoundEffectSubmix ( const UObject* WorldContextObject,
USoundSubmix* InSoundSubmix,
int32 SubmixChainIndex,
USoundEffectSubmixPreset* SubmixEffectPreset
)

   AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject", DeprecatedFunction)

static void ReplaceSubmixEffect ( const UObject* WorldContextObject,
USoundSubmix* InSoundSubmix,
int32 SubmixChainIndex,
USoundEffectSubmixPreset* SubmixEffectPreset
)

 Replaces the submix effect at the given submix chain index, adds the effect if there is none at that index. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject")

static void ResumeRecordingOutput ( const UObject* WorldContextObject,
USoundSubmix* SubmixToPause
)

 Resume recording audio after pausing. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Recording"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay=1)

static void SetBypassSourceEffectChainEntry ( const UObject* WorldContextObject,
USoundEffectSourcePresetChain* PresetChain,
int32 EntryIndex,
bool bBypassed
)

 Set whether or not to bypass the effect at the source effect chain index. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject")

static void SetSubmixEffectChainOverride ( const UObject* WorldContextObject,
USoundSubmix* SoundSubmix,
TArray< USoundEffectSubmixPreset* > SubmixEffectPresetChain,
float FadeTimeSec
)

 Sets a submix effect chain override on the given submix. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Effects"
  • Meta=(WorldContext="WorldContextObject")

static void StartAnalyzingOutput ( const UObject* WorldContextObject,
USoundSubmix* SubmixToAnalyze,
EFFTSize FFTSize,
EFFTPeakInterpolationMethod InterpolationMethod,
EFFTWindowType WindowType,
float HopSize,
EAudioSpectrumType SpectrumType
)

 Start spectrum analysis of the audio output. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Analysis"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay=1)

static void StartAudioBus ( const UObject* WorldContextObject,
UAudioBus* AudioBus
)

 Starts the given audio bus. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Bus"
  • Meta=(WorldContext="WorldContextObject")

static void StartRecordingOutput ( const UObject* WorldContextObject,
float ExpectedDuration,
USoundSubmix* SubmixToRecord
)

 Start recording audio. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Recording"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay=1)

static void StopAnalyzingOutput ( const UObject* WorldContextObject,
USoundSubmix* SubmixToStopAnalyzing
)

 Stop spectrum analysis. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Analysis"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay=1)

static void StopAudioBus ( const UObject* WorldContextObject,
UAudioBus* AudioBus
)

 Stops the given audio bus. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Bus"
  • Meta=(WorldContext="WorldContextObject")

static USoundWave * StopRecordingOutput ( const UObject* WorldContextObject,
EAudioRecordingExportType ExportType,
const FString& Name,
FString Path,
USoundSubmix* SubmixToRecord,
USoundWave* ExistingSoundWaveToOverwrite
)

 Stop recording audio. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Recording"
  • Meta=(WorldContext="WorldContextObject", DisplayName="Finish Recording Output", AdvancedDisplay=4)

static void SwapAudioOutputDevice ( const UObject* WorldContextObject,
const FString& NewDeviceId,
const FOnCompletedDeviceSwap& OnCompletedDeviceSwap
)

 Hotswaps to the requested audio output device AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio"
  • Meta=(WorldContext="WorldContextObject")

static float TrimAudioCache ( float InMegabytesToFree
)

 Trim memory used by the audio cache. Returns the number of megabytes freed. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Cache"

static void UnregisterAudioBusFromSubmix ( const UObject* WorldContextObject,
USoundSubmix* SoundSubmix,
UAudioBus* AudioBus
)

 Unregisters an audio bus that could have been registered to a submix. AudioMixerBlueprintLibrary.h
  • BlueprintCallable
  • Category="Audio|Bus"
  • Meta=(WorldContext="WorldContextObject")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page