FSubmixEffectDynamicsProcessor

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSoundEffectBase

FSoundEffectSubmix

FSubmixEffectDynamicsProcessor

References

Module

AudioMixer

Header

/Engine/Source/Runtime/AudioMixer/Classes/SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h

Include

#include "SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h"

Syntax

class FSubmixEffectDynamicsProcessor : public FSoundEffectSubmix

Variables

Name Description

Protected variable

Audio::FAligned...

 

AudioExternal

Protected variable

TArray< float >

 

AudioInputFrame

Protected variable

TArray< float >

 

AudioKeyFrame

Protected variable

bool

 

bBypass

Protected variable

Audio::FDeviceI...

 

DeviceId

Constructors

Destructors

Functions

Name Description

Public function Const

Audio::FDevi...

 

GetDeviceId()

Gets the effect's deviceId that owns it.

Protected function

Audio::FMixe...

 

GetMixerDevice()

Protected function

void

 

OnDeviceCreated

(
    Audio::FDeviceId InDeviceId
)

Protected function

void

 

OnDeviceDestroyed

(
    Audio::FDeviceId InDeviceId
)

Protected function

void

 

ResetKey()

Protected function

void

 

UpdateKeyFromSettings

(
    const FSubmixEffectDynamicsProcesso...
)

Protected function

bool

 

UpdateKeySourcePatch()

Overridden from FSoundEffectSubmix

Name Description

Public function Virtual

void

 

Init

(
    const FSoundEffectSubmixInitData& ...
)

Called on an audio effect at initialization on audio thread before audio processing begins.

Public function Virtual

void

 

OnProcessAudio

(
    const FSoundEffectSubmixInputData&...,
    FSoundEffectSubmixOutputData& OutD...
)

Process the input block of audio. Called on audio render thread.

Overridden from FSoundEffectBase

Name Description

Public function Virtual

void

 

OnPresetChanged()

Called when an audio effect preset is changed.