Navigation
Unreal Engine C++ API Reference > Runtime > Engine > Sound
Inheritance Hierarchy
- FSoundEffectBase
- FSoundEffectSubmix
- FSubmixEffectConvolutionReverb
- FSubmixEffectDelay
- FSubmixEffectDynamicsProcessor
- FSubmixEffectFilter
- FSubmixEffectFlexiverb
- FSubmixEffectMultibandCompressor
- FSubmixEffectReverb
- FSubmixEffectStereoDelay
- FSubmixEffectStereoToQuad
- FSubmixEffectSubmixEQ
- FSubmixEffectTapDelay
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/Sound/SoundEffectSubmix.h |
| Include | #include "Sound/SoundEffectSubmix.h" |
Syntax
class FSoundEffectSubmix : public FSoundEffectBase
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
uint32 | Override to down mix input audio to a desired channel count. | |
   |
float | GetDryLevel () |
Allow effects to supply a drylevel. |
  |
const FSoundEffectSubmixInitData & | GetInitData () |
Returns the data that was given to the source effect when initialized. |
  |
void | OnProcessAudio
(
const FSoundEffectSubmixInputData& InData, |
Process the input block of audio. Called on audio thread. |
 |
bool | ProcessAudio
(
FSoundEffectSubmixInputData& InData, |
Processes audio in the submix effect. |
  |
bool | SetParameters
(
const FAudioEffectParameters& InParameters |
Provided for interpolating parameters from audio volume system, enabling transition between various settings. |
 |
void | Setup
(
const FSoundEffectSubmixInitData& InInitData |
Called by the audio engine or systems internally. This function calls the virtual Init function implemented by derived classes. |
   |
bool | Whether or not effect supports default EQ system. | |
   |
bool | Whether or not effect supports default reverb system. | |
  |
void | Tick () |
Called on game thread to allow submix effect to query game data if needed. |