UAudioMixerBlueprintLibrary

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

AudioMixer

Header

/Engine/Source/Runtime/AudioMixer/Public/AudioMixerBlueprintLibrary.h

Include

#include "AudioMixerBlueprintLibrary.h"

Syntax

class UAudioMixerBlueprintLibrary : public UBlueprintFunctionLibrary

Functions

Name Description

Public function Static

void

 

AddMasterSubmixEffect

(
    const UObject* WorldContextObj...,
    USoundEffectSubmixPreset* Subm...
)

Adds a submix effect preset to the master submix.

Public function Static

void

 

AddSourceEffectToPresetChain

(
    const UObject* WorldContextObj...,
    USoundEffectSourcePresetChain*...,
    FSourceEffectChainEntry Entry
)

Adds source effect entry to preset chain. Only effects the instance of the preset chain

Public function Static

int32

 

AddSubmixEffect

(
    const UObject* WorldContextObj...,
    USoundSubmix* SoundSubmix,
    USoundEffectSubmixPreset* Subm...
)

Adds a submix effect preset to the given submix at the end of its submix effect chain.

Public function Static

void

 

ClearMasterSubmixEffects

(
    const UObject* WorldContextObj...
)

Clears all master submix effects.

Public function Static

void

 

ClearSubmixEffectChainOverride

(
    const UObject* WorldContextObj...,
    USoundSubmix* SoundSubmix,
    float FadeTimeSec
)

Clears all submix effect overrides on the given submix and returns it to the default effect chain.

Public function Static

void

 

ClearSubmixEffects

(
    const UObject* WorldContextObj...,
    USoundSubmix* SoundSubmix
)

Clears all submix effects on the given submix.

Public function Static

FString

 

Conv_AudioOutputDeviceInfoToString

(
    const FAudioOutputDeviceInfo& Info
)

Returns the device info in a human readable format

Public function Static

void

 

GetAvailableAudioOutputDevices

(
    const UObject* WorldContextObj...,
    const FOnAudioOutputDevicesObtained...
)

Gets information about all audio output devices available in the system

Public function Static

void

 

GetCurrentAudioOutputDeviceName

(
    const UObject* WorldContextObj...,
    const FOnMainAudioOutputDeviceObtai...
)

Gets information about the currently used audio output device

Public function Static

void

 

GetMagnitudeForFrequencies

(
    const UObject* WorldContextObj...,
    const TArray< float >& Frequencies,
    TArray< float >& Magnitudes,
    USoundSubmix* SubmixToAnalyze
)

Retrieve the magnitudes for the given frequencies.

Public function Static

int32

 

GetNumberOfEntriesInSourceEffectChain

(
    const UObject* WorldContextObj...,
    USoundEffectSourcePresetChain*...
)

Returns the number of effect chain entries in the given source effect chain.

Public function Static

void

 

GetPhaseForFrequencies

(
    const UObject* WorldContextObj...,
    const TArray< float >& Frequencies,
    TArray< float >& Phases,
    USoundSubmix* SubmixToAnalyze
)

Retrieve the phases for the given frequencies.

Public function Static

bool

 

IsAudioBusActive

(
    const UObject* WorldContextObj...,
    UAudioBus* AudioBus
)

Queries if the given audio bus is active (and audio can be mixed to it).

Public function Static

TArray< FSou...

 

MakeFullSpectrumSpectralAnalysisBandSettings

(
    int32 InNumBands,
    float InMinimumFrequency,
    float InMaximumFrequency,
    int32 InAttackTimeMsec,
    int32 InReleaseTimeMsec
)

Make an array of logarithmically spaced bands.

Public function Static

TArray< FSou...

 

MakeMusicalSpectralAnalysisBandSettings

(
    int32 InNumSemitones,
    EMusicalNoteName InStartingMusicalN...,
    int32 InStartingOctave,
    int32 InAttackTimeMsec,
    int32 InReleaseTimeMsec
)

Make an array of musically spaced bands with ascending frequency.

Public function Static

TArray< FSou...

 

MakePresetSpectralAnalysisBandSettings

(
    EAudioSpectrumBandPresetType InBand...,
    int32 InNumBands,
    int32 InAttackTimeMsec,
    int32 InReleaseTimeMsec
)

Make an array of bands which span the frequency range of a given EAudioSpectrumBandPresetType.

Public function Static

void

 

PauseRecordingOutput

(
    const UObject* WorldContextObj...,
    USoundSubmix* SubmixToPause
)

Pause recording audio, without finalizing the recording to disk.

Public function Static

void

 

PrimeSoundCueForPlayback

(
    USoundCue* SoundCue
)

Begin loading any sounds referenced by a sound cue into the cache so that it can be played immediately.

Public function Static

void

 

PrimeSoundForPlayback

(
    USoundWave* SoundWave,
    const FOnSoundLoadComplete OnLoadCo...
)

Begin loading a sound into the cache so that it can be played immediately.

Public function Static

void

 

RemoveMasterSubmixEffect

(
    const UObject* WorldContextObj...,
    USoundEffectSubmixPreset* Subm...
)

Removes a submix effect preset from the master submix.

Public function Static

void

 

RemoveSourceEffectFromPresetChain

(
    const UObject* WorldContextObj...,
    USoundEffectSourcePresetChain*...,
    int32 EntryIndex
)

Adds source effect entry to preset chain. Only affects the instance of preset chain.

Public function Static

void

 

RemoveSubmixEffect

(
    const UObject* WorldContextObj...,
    USoundSubmix* SoundSubmix,
    USoundEffectSubmixPreset* Subm...
)

Removes all instances of a submix effect preset from the given submix.

Public function Static

void

 

RemoveSubmixEffectAtIndex

(
    const UObject* WorldContextObj...,
    USoundSubmix* SoundSubmix,
    int32 SubmixChainIndex
)

Removes the submix effect at the given submix chain index, if there is a submix effect at that index.

Public function Static

void

 

ReplaceSubmixEffect

(
    const UObject* WorldContextObj...,
    USoundSubmix* InSoundSubmix,
    int32 SubmixChainIndex,
    USoundEffectSubmixPreset* Subm...
)

Replaces the submix effect at the given submix chain index, adds the effect if there is none at that index.

Public function Static

void

 

ResumeRecordingOutput

(
    const UObject* WorldContextObj...,
    USoundSubmix* SubmixToPause
)

Resume recording audio after pausing.

Public function Static

void

 

SetBypassSourceEffectChainEntry

(
    const UObject* WorldContextObj...,
    USoundEffectSourcePresetChain*...,
    int32 EntryIndex,
    bool bBypassed
)

Set whether or not to bypass the effect at the source effect chain index.

Public function Static

void

 

SetSubmixEffectChainOverride

(
    const UObject* WorldContextObj...,
    USoundSubmix* SoundSubmix,
    TArray< USoundEffectSubmixPreset&#...,
    float FadeTimeSec
)

Sets a submix effect chain override on the given submix.

Public function Static

void

 

StartAnalyzingOutput

(
    const UObject* WorldContextObj...,
    USoundSubmix* SubmixToAnalyze,
    EFFTSize FFTSize,
    EFFTPeakInterpolationMethod Interpo...,
    EFFTWindowType WindowType,
    float HopSize,
    EAudioSpectrumType SpectrumType
)

Start spectrum analysis of the audio output.

Public function Static

void

 

StartAudioBus

(
    const UObject* WorldContextObj...,
    UAudioBus* AudioBus
)

Starts the given audio bus.

Public function Static

void

 

StartRecordingOutput

(
    const UObject* WorldContextObj...,
    float ExpectedDuration,
    USoundSubmix* SubmixToRecord
)

Start recording audio.

Public function Static

void

 

StopAnalyzingOutput

(
    const UObject* WorldContextObj...,
    USoundSubmix* SubmixToStopAnal...
)

Stop spectrum analysis.

Public function Static

void

 

StopAudioBus

(
    const UObject* WorldContextObj...,
    UAudioBus* AudioBus
)

Stops the given audio bus.

Public function Static

USoundWave &...

 

StopRecordingOutput

(
    const UObject* WorldContextObj...,
    EAudioRecordingExportType ExportTyp...,
    const FString& Name,
    FString Path,
    USoundSubmix* SubmixToRecord,
    USoundWave* ExistingSoundWaveT...
)

Stop recording audio.

Public function Static

void

 

SwapAudioOutputDevice

(
    const UObject* WorldContextObj...,
    const FString& NewDeviceId,
    const FOnCompletedDeviceSwap& OnCo...
)

Hotswaps to the requested audio output device

Public function Static

float

 

TrimAudioCache

(
    float InMegabytesToFree
)

Trim memory used by the audio cache. Returns the number of megabytes freed.

Deprecated Functions

Name Description

Public function Static

void

 

RemoveSubmixEffectPreset

(
    const UObject* WorldContextObj...,
    USoundSubmix* SoundSubmix,
    USoundEffectSubmixPreset* Subm...
)

RemoveSubmixEffectPreset is deprecated, use RemoveSubmixEffect.

Public function Static

void

 

RemoveSubmixEffectPresetAtIndex

(
    const UObject* WorldContextObj...,
    USoundSubmix* SoundSubmix,
    int32 SubmixChainIndex
)

RemoveSubmixEffectPresetAtIndex is deprecated, use RemoveSubmixEffectAtIndex.

Public function Static

void

 

ReplaceSoundEffectSubmix

(
    const UObject* WorldContextObj...,
    USoundSubmix* InSoundSubmix,
    int32 SubmixChainIndex,
    USoundEffectSubmixPreset* Subm...
)

ReplaceSoundEffectSubmix is deprecated, use ReplaceSubmixEffect.