FSubmixEffectFilter

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSoundEffectBase

FSoundEffectSubmix

FSubmixEffectFilter

References

Module

Synthesis

Header

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

Include

#include "SubmixEffects/SubmixEffectFilter.h"

Syntax

class FSubmixEffectFilter : public FSoundEffectSubmix

Constructors

Name Description

Public function

FSubmixEffectFilter()

Destructors

Name Description

Public function Virtual

~FSubmixEffectFilter()

Functions

Name Description

Public function

void

 

SetFilterAlgorithm

(
    ESubmixFilterAlgorithm InAlgorithm
)

Sets the filter algorithm.

Public function

void

 

SetFilterCutoffFrequency

(
    float InFrequency
)

Sets the base filter cutoff frequency.

Public function

void

 

SetFilterCutoffFrequencyMod

(
    float InFrequency
)

Sets the mod filter cutoff frequency.

Public function

void

 

SetFilterQ

(
    float InQ
)

Sets the filter Q.

Public function

void

 

SetFilterQMod

(
    float InQ
)

Sets the filter Q.

Public function

void

 

SetFilterType

(
    ESubmixFilterType InType
)

Sets the filter type.

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 the sound effect's preset changed.