FModulationDestination

Choose your operating system:

Windows

macOS

Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Sound/SoundModulationDestination.h

Include

#include "Sound/SoundModulationDestination.h"

Syntax

struct FModulationDestination

Constructors

Functions

Name Description

Public function Const

const FAlign...

 

GetBuffer()

Returns buffer of interpolated modulation values.

Public function Const

bool

 

GetHasProcessed()

Returns whether or not the destination has requested to process the control or not.

Public function Const

float

 

GetValue()

Returns sample value last reported by modulator.

Public function

void

 

Init

(
    FDeviceId InDeviceId,
    bool bInIsBuffered,
    bool bInValueNormalized
)

Initializes the modulation destination InDeviceId - DeviceId associated with modulation plugin instance bInIsBuffered - Whether or not to run destination in "buffered mode," which manages an internal buffer to smooth modulation value between process calls bInValueNormalized - Whether or not to keep the output value in normalized, unitless [0.0f, 1.0f] space

Public function

void

 

Init

(
    FDeviceId InDeviceId,
    FName InParameterName,
    bool bInIsBuffered,
    bool bInValueNormalized
)

Initializes the modulation destination InDeviceId - DeviceId associated with modulation plugin instance InParameterName - Name of parameter used to mix/convert destination value to/from unit space bInIsBuffered - Whether or not to run destination in "buffered mode," which manages an internal buffer to smooth modulation value between process calls bInValueNormalized - Whether or not to keep the output value in normalized, unitless [0.0f, 1.0f] space

Public function

bool

 

IsActive()

Returns whether or not destination references an active modulator

Public function

bool

 

ProcessControl

(
    float InValueUnitBase,
    int32 InNumSamples
)

Updates internal value (or buffer if set to bIsBuffered) to current modulated result using the provided value as the base carrier value to modulate.

Public function

void

 

UpdateModulator

(
    const USoundModulatorBase* InM...
)

Operators

Name Description

Public function

FModulationD...

 

operator=

(
    const FModulationDestination& InMo...
)

Public function

FModulationD...

 

operator=

(
    FModulationDestination&& InModulat...
)