Navigation
API > API/Runtime > API/Runtime/AudioMixer
| Name | FSubmixEffectDynamicsProcessor |
| Type | class |
| Header File | /Engine/Source/Runtime/AudioMixer/Classes/SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h |
| Include Path | #include "SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h" |
Syntax
class FSubmixEffectDynamicsProcessor : public FSoundEffectSubmix
Inheritance Hierarchy
- FSoundEffectBase → FSoundEffectSubmix → FSubmixEffectDynamicsProcessor
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSubmixEffectDynamicsProcessor() |
SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSubmixEffectDynamicsProcessor() |
SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DeviceCreatedHandle | FDelegateHandle | SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h | ||
| DeviceDestroyedHandle | FDelegateHandle | SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h | ||
| DynamicsProcessor | Audio::FDynamicsProcessor | SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h | ||
| KeySource | FKeySource | SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
Audio::FDeviceId GetDeviceId() |
Gets the effect's deviceId that owns it. | SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h | |
virtual void Init
(
const FSoundEffectSubmixInitData& InInitData |
Called on an audio effect at initialization on audio thread before audio processing begins. | SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h | |
virtual void OnPresetChanged() |
Called when an audio effect preset is changed. | SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h | |
virtual void OnProcessAudio
(
const FSoundEffectSubmixInputData& InData, |
Process the input block of audio. Called on audio render thread. | SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
Audio::FMixerDevice * GetMixerDevice() |
SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h | ||
void OnDeviceCreated
(
Audio::FDeviceId InDeviceId |
SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h | ||
void OnDeviceDestroyed
(
Audio::FDeviceId InDeviceId |
SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h | ||
void ResetKey() |
SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h | ||
void UpdateKeyFromSettings
(
const FSubmixEffectDynamicsProcessorSettings& InSettings |
SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h | ||
bool UpdateKeySourcePatch() |
SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h |