UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
EQ.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "CoreMinimal.h"
6#include "DSP/Filter.h"
7
8namespace Audio
9{
10 // Equalizer filter
11 // An equalizer is a cascaded (serial) band of parametric EQs
12 // This filter allows for setting each band with variable Bandwidth/Q, Frequency, and Gain
14 {
15 public:
16 // Constructor
18
19 // Destructor
21
22 // Initialize the equalizer
24
25 // Sets whether or not the band is enabled
26 SIGNALPROCESSING_API void SetBandEnabled(const int32 InBand, const bool bEnabled);
27
28 // Sets all params of the band at once
29 SIGNALPROCESSING_API void SetBandParams(const int32 InBand, const float InFrequency, const float InBandwidth, const float InGainDB);
30
31 // Sets the band frequency
33
34 // Sets the band resonance (use alternatively to bandwidth)
36
37 // Sets the band gain in decibels
39
40 // Processes the audio frame (audio frame must have channels equal to that used during initialization)
41 SIGNALPROCESSING_API void ProcessAudioFrame(const float* InAudio, float* OutAudio);
42
43 private:
44
45 // The number of channels in the equalizer
46 int32 NumChannels;
47
48 // The array of biquad filters
49 TArray<FBiquadFilter> FilterBands;
50
51 // Temporary array for processing audio.
52 TArray<float> WorkBuffer;
53 };
54
55}
FPlatformTypes::int32 int32
A 32-bit signed integer.
Definition Platform.h:1125
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
void Init()
Definition LockFreeList.h:4
Definition EQ.h:14
SIGNALPROCESSING_API void SetBandParams(const int32 InBand, const float InFrequency, const float InBandwidth, const float InGainDB)
Definition EQ.cpp:37
SIGNALPROCESSING_API void SetBandBandwidth(const int32 InBand, const float InBandwidth)
Definition EQ.cpp:47
SIGNALPROCESSING_API void SetBandEnabled(const int32 InBand, const bool bEnabled)
Definition EQ.cpp:32
SIGNALPROCESSING_API FEqualizer()
Definition EQ.cpp:8
SIGNALPROCESSING_API void SetBandFrequency(const int32 InBand, const float InFrequency)
Definition EQ.cpp:42
SIGNALPROCESSING_API void ProcessAudioFrame(const float *InAudio, float *OutAudio)
Definition EQ.cpp:57
SIGNALPROCESSING_API void SetBandGainDB(const int32 InBand, const float InGainDB)
Definition EQ.cpp:52
SIGNALPROCESSING_API ~FEqualizer()
Definition EQ.cpp:13
Definition Array.h:670
NO_LOGGING.
Definition AudioMixerPlatformAndroid.cpp:53