FSubmixEffectMultibandCompressor

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSoundEffectBase

FSoundEffectSubmix

FSubmixEffectMultibandCompressor

References

Module

Synthesis

Header

/Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SubmixEffects/SubmixEffectMultiBandCompressor.h

Include

#include "SubmixEffects/SubmixEffectMultiBandCompressor.h"

Syntax

class FSubmixEffectMultibandCompressor : public FSoundEffectSubmix

Variables

Name Description

Protected variable

Audio::FAligned...

 

AudioExternal

Constructors

Destructors

Functions

Name Description

Public function Const

Audio::FDevi...

 

GetDeviceId()

Gets the effect's deviceId that owns it.

Protected function

Audio::FMixe...

 

GetMixerDevice()

Public function

void

 

Initialize

Called from OnPresetChanged when something is changed that needs extra attention

Protected function

void

 

OnDeviceCreated

(
    Audio::FDeviceId InDeviceId
)

Protected function

void

 

OnDeviceDestroyed

(
    Audio::FDeviceId InDeviceId
)

Protected function

void

 

ResetKey()

Protected function

void

 

UpdateKeyFromSettings

(
    const FSubmixEffectMultibandCompres...
)

Protected function

bool

 

UpdateKeySourcePatch()

Overridden from FSoundEffectSubmix

Name Description

Public function Virtual

void

 

Init

(
    const FSoundEffectSubmixInitData& ...
)

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

Public function Virtual

void

 

OnProcessAudio

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

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

Overridden from FSoundEffectBase

Name Description

Public function Virtual

void

 

OnPresetChanged()

Called when an audio effect preset is changed.