Navigation
API > API/Runtime > API/Runtime/Engine
| Name | FSoundEffectSubmix |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Sound/SoundEffectSubmix.h |
| Include Path | #include "Sound/SoundEffectSubmix.h" |
Syntax
class FSoundEffectSubmix : public FSoundEffectBase
Inheritance Hierarchy
- FSoundEffectBase → FSoundEffectSubmix
Derived Classes
FSoundEffectSubmix derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSoundEffectSubmix() |
Sound/SoundEffectSubmix.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSoundEffectSubmix() |
Sound/SoundEffectSubmix.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| InitData_Internal | FSoundEffectSubmixInitData | Sound/SoundEffectSubmix.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual uint32 GetDesiredInputChannelCountOverride() |
Override to down mix input audio to a desired channel count. | Sound/SoundEffectSubmix.h | |
virtual float GetDryLevel() |
Allow effects to supply a drylevel. | Sound/SoundEffectSubmix.h | |
const FSoundEffectSubmixInitData & GetInitData() |
Returns the data that was given to the source effect when initialized. | Sound/SoundEffectSubmix.h | |
virtual void OnProcessAudio
(
const FSoundEffectSubmixInputData& InData, |
Process the input block of audio. Called on audio thread. | Sound/SoundEffectSubmix.h | |
bool ProcessAudio
(
FSoundEffectSubmixInputData& InData, |
Processes audio in the submix effect. | Sound/SoundEffectSubmix.h | |
virtual bool SetParameters
(
const FAudioEffectParameters& InParameters |
Provided for interpolating parameters from audio volume system, enabling transition between various settings. | Sound/SoundEffectSubmix.h | |
void Setup
(
const FSoundEffectSubmixInitData& InInitData |
Called by the audio engine or systems internally. This function calls the virtual Init function implemented by derived classes. | Sound/SoundEffectSubmix.h | |
virtual bool SupportsDefaultEQ() |
Whether or not effect supports default EQ system. | Sound/SoundEffectSubmix.h | |
virtual bool SupportsDefaultReverb() |
Whether or not effect supports default reverb system. | Sound/SoundEffectSubmix.h | |
virtual void Tick() |
Called on game thread to allow submix effect to query game data if needed. | Sound/SoundEffectSubmix.h |