Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → UBlueprintFunctionLibrary → UAudioMixerBlueprintLibrary
Functions
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddMasterSubmixEffect
(
const UObject* WorldContextObject, |
Adds a submix effect preset to the master submix. | AudioMixerBlueprintLibrary.h |
|
static void AddSourceEffectToPresetChain
(
const UObject* WorldContextObject, |
Adds source effect entry to preset chain. Only effects the instance of the preset chain | AudioMixerBlueprintLibrary.h |
|
static int32 AddSubmixEffect
(
const UObject* WorldContextObject, |
Adds a submix effect preset to the given submix at the end of its submix effect chain. | AudioMixerBlueprintLibrary.h |
|
static void ClearMasterSubmixEffects
(
const UObject* WorldContextObject |
Clears all master submix effects. | AudioMixerBlueprintLibrary.h |
|
static void ClearSubmixEffectChainOverride
(
const UObject* WorldContextObject, |
Clears all submix effect overrides on the given submix and returns it to the default effect chain. | AudioMixerBlueprintLibrary.h |
|
static void ClearSubmixEffects
(
const UObject* WorldContextObject, |
Clears all submix effects on the given submix. | AudioMixerBlueprintLibrary.h |
|
static FString Conv_AudioOutputDeviceInfoToString
(
const FAudioOutputDeviceInfo& Info |
Returns the device info in a human readable format | AudioMixerBlueprintLibrary.h |
|
static void GetAvailableAudioOutputDevices
(
const UObject* WorldContextObject, |
Gets information about all audio output devices available in the system | AudioMixerBlueprintLibrary.h |
|
static void GetCurrentAudioOutputDeviceName
(
const UObject* WorldContextObject, |
Gets information about the currently used audio output device | AudioMixerBlueprintLibrary.h |
|
| Retrieve the magnitudes for the given frequencies. | AudioMixerBlueprintLibrary.h |
|
|
static int32 GetNumberOfEntriesInSourceEffectChain
(
const UObject* WorldContextObject, |
Returns the number of effect chain entries in the given source effect chain. | AudioMixerBlueprintLibrary.h |
|
| Retrieve the phases for the given frequencies. | AudioMixerBlueprintLibrary.h |
|
|
static bool IsAudioBusActive
(
const UObject* WorldContextObject, |
Queries if the given audio bus is active (and audio can be mixed to it). | AudioMixerBlueprintLibrary.h |
|
static TArray< FSoundSubmixSpectralAnalysisBandSettings > MakeFullSpectrumSpectralAnalysisBandSettings
(
int32 InNumBands, |
Make an array of logarithmically spaced bands. | AudioMixerBlueprintLibrary.h |
|
static TArray< FSoundSubmixSpectralAnalysisBandSettings > MakeMusicalSpectralAnalysisBandSettings
(
int32 InNumSemitones, |
Make an array of musically spaced bands with ascending frequency. | AudioMixerBlueprintLibrary.h |
|
static TArray< FSoundSubmixSpectralAnalysisBandSettings > MakePresetSpectralAnalysisBandSettings
(
EAudioSpectrumBandPresetType InBandPresetType, |
Make an array of bands which span the frequency range of a given EAudioSpectrumBandPresetType. | AudioMixerBlueprintLibrary.h |
|
static void PauseRecordingOutput
(
const UObject* WorldContextObject, |
Pause recording audio, without finalizing the recording to disk. | AudioMixerBlueprintLibrary.h |
|
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 |
|
static void PrimeSoundForPlayback
(
USoundWave* SoundWave, |
Begin loading a sound into the cache so that it can be played immediately. | AudioMixerBlueprintLibrary.h |
|
static void RegisterAudioBusToSubmix
(
const UObject* WorldContextObject, |
Registers an audio bus to a submix so the submix output can be routed to the audiobus. | AudioMixerBlueprintLibrary.h |
|
static void RemoveMasterSubmixEffect
(
const UObject* WorldContextObject, |
Removes a submix effect preset from the master submix. | AudioMixerBlueprintLibrary.h |
|
static void RemoveSourceEffectFromPresetChain
(
const UObject* WorldContextObject, |
Removes source effect entry from preset chain. Only affects the instance of preset chain. | AudioMixerBlueprintLibrary.h |
|
static void RemoveSubmixEffect
(
const UObject* WorldContextObject, |
Removes all instances of a submix effect preset from the given submix. | AudioMixerBlueprintLibrary.h |
|
static void RemoveSubmixEffectAtIndex
(
const UObject* WorldContextObject, |
Removes the submix effect at the given submix chain index, if there is a submix effect at that index. | AudioMixerBlueprintLibrary.h |
|
static void RemoveSubmixEffectPreset
(
const UObject* WorldContextObject, |
AudioMixerBlueprintLibrary.h |
|
|
static void RemoveSubmixEffectPresetAtIndex
(
const UObject* WorldContextObject, |
AudioMixerBlueprintLibrary.h |
|
|
static void ReplaceSoundEffectSubmix
(
const UObject* WorldContextObject, |
AudioMixerBlueprintLibrary.h |
|
|
static void ReplaceSubmixEffect
(
const UObject* WorldContextObject, |
Replaces the submix effect at the given submix chain index, adds the effect if there is none at that index. | AudioMixerBlueprintLibrary.h |
|
static void ResumeRecordingOutput
(
const UObject* WorldContextObject, |
Resume recording audio after pausing. | AudioMixerBlueprintLibrary.h |
|
static void SetBypassSourceEffectChainEntry
(
const UObject* WorldContextObject, |
Set whether or not to bypass the effect at the source effect chain index. | AudioMixerBlueprintLibrary.h |
|
static void SetSubmixEffectChainOverride
(
const UObject* WorldContextObject, |
Sets a submix effect chain override on the given submix. | AudioMixerBlueprintLibrary.h |
|
static void StartAnalyzingOutput
(
const UObject* WorldContextObject, |
Start spectrum analysis of the audio output. | AudioMixerBlueprintLibrary.h |
|
static void StartAudioBus
(
const UObject* WorldContextObject, |
Starts the given audio bus. | AudioMixerBlueprintLibrary.h |
|
static void StartRecordingOutput
(
const UObject* WorldContextObject, |
Start recording audio. | AudioMixerBlueprintLibrary.h |
|
static void StopAnalyzingOutput
(
const UObject* WorldContextObject, |
Stop spectrum analysis. | AudioMixerBlueprintLibrary.h |
|
static void StopAudioBus
(
const UObject* WorldContextObject, |
Stops the given audio bus. | AudioMixerBlueprintLibrary.h |
|
static USoundWave * StopRecordingOutput
(
const UObject* WorldContextObject, |
Stop recording audio. | AudioMixerBlueprintLibrary.h |
|
static void SwapAudioOutputDevice
(
const UObject* WorldContextObject, |
Hotswaps to the requested audio output device | AudioMixerBlueprintLibrary.h |
|
static float TrimAudioCache
(
float InMegabytesToFree |
Trim memory used by the audio cache. Returns the number of megabytes freed. | AudioMixerBlueprintLibrary.h |
|
static void UnregisterAudioBusFromSubmix
(
const UObject* WorldContextObject, |
Unregisters an audio bus that could have been registered to a submix. | AudioMixerBlueprintLibrary.h |
|