FSourceEffectMotionFilter

======================================================================== [FSourceEffectMotionFilter](API\Plugins\Synthesis\SourceEffects\FSourceEffectMotionFilter)This is the instance of the source effect.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSoundEffectBase

FSoundEffectSource

FSourceEffectMotionFilter

References

Module

Synthesis

Header

/Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SourceEffects/SourceEffectMotionFilter.h

Include

#include "SourceEffects/SourceEffectMotionFilter.h"

Syntax

class FSourceEffectMotionFilter : public FSoundEffectSource

Remarks

======================================================================== FSourceEffectMotionFilterThis is the instance of the source effect. Performs DSP calculations.

Variables

Name Description

Protected variable

TArray< float >

 

BaseDestinationValues

Base Destination Values.

Protected variable

float

 

ChannelRate

SampleRate * NumChannels.

Protected variable

float

 

DryVolumeScalar

Attenuation of sound in linear units.

Protected variable

float

 

FilterAMixScale

Filter Output Scalars.

Protected variable

float

 

FilterAOutputScale

Protected variable

float

 

FilterBMixScale

Protected variable

float

 

FilterBOutputScale

Protected variable

float

 

FilterMixAmount

Filter Mix.

Protected variable

float

 

LastDistance

Protected variable

FVector

 

LastEmitterNormalizedPosition

Protected variable

FVector

 

LastEmitterWorldPosition

Protected variable

FVector

 

LastListenerWorldPosition

Protected variable

TArray< TArray<...

 

LastTargetMatrix

Last Target values for the Mod Matrix.

Protected variable

TArray< TArray<...

 

LinearEaseMatrix

Linear Ease Matrix.

Protected variable

TArray< TArray<...

 

LinearEaseMatrixInit

Linear Ease Matrix is Initialized.

Protected variable

TArray< float >

 

ModDestinationUpdateTimeMS

Modulation Destination Values.

Protected variable

TArray< float >

 

ModDestinationValues

Modulation Destination Values.

Protected variable

TMap< ESourceEf...

 

ModMap

Mod Map.

Protected variable

TMap< ESourceEf...

 

ModMapOutputRange

Mod Map Random Output Range.

Protected variable

TArray< TArray<...

 

ModMatrix

Current Mod Matrix comprised of [Source] x [Destination] coordinates.

Protected variable

TArray< float >

 

ModSources

Modulation Sources.

Protected variable

double

 

ModSourceTimeStamp

This is the last time Mod Source data has been updated.

Protected variable

FMotionFilter

 

MotionFilterA

Protected variable

FMotionFilter

 

MotionFilterB

Protected variable

int32

 

NumChannels

Number of channels in source.

Protected variable

float

 

SampleRate

Sample Rate cached.

Protected variable

Audio::FAligned...

 

ScratchBufferA

Intermediary Scratch Buffers.

Protected variable

Audio::FAligned...

 

ScratchBufferB

Protected variable

TArray< TArray<...

 

TargetMatrix

Target values for the Mod Matrix.

Protected variable

ESourceEffectMo...

 

Topology

Motion filter topology.

Constructors

Name Description

Public function

FSourceEffectMotionFilter()

Functions

Name Description

Protected function

void

 

ApplyFilterModulation

(
    const TArray< float >& Destination...
)

Applies modulation changes to Filter based on Destination Input Values.

Protected function

void

 

UpdateFilter

(
    FMotionFilter* MotionFilter,
    ESourceEffectMotionFilterCircuit Fi...,
    ESourceEffectMotionFilterType Motio...,
    float FilterFrequency,
    float FilterQ
)

Update Filter Parameters.

Protected function

void

 

UpdateModulationDestinations()

Updates Modulation Destinations based on updated Matrix Values.

Protected function

bool

 

UpdateModulationMatrix

(
    const float UpdateTime
)

Updates Modulated Parameters, returns true if parameters were updated.

Protected function

void

 

UpdateModulationSources

(
    const FSoundEffectSourceInputData&...
)

Update Modulation Source Parameters.

Overridden from FSoundEffectSource

Name Description

Public function Virtual

void

 

Init

(
    const FSoundEffectSourceInitData& ...
)

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

Public function Virtual

void

 

ProcessAudio

(
    const FSoundEffectSourceInputData&...,
    float* OutAudioBufferData
)

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.