Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Sound > FModulationDestination

Light Theme

Dark Theme

FModulationDestination

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Sound/SoundModulationDestination.h
Include	#include "Sound/SoundModulationDestination.h"

Syntax

struct FModulationDestination

Constructors

	Name	Description
	FModulationDestination()
	FModulationDestination ( const FModulationDestination& InMo... )

Functions

	Name	Description
const FAlign...	GetBuffer()	Returns buffer of interpolated modulation values
bool	GetHasProcessed()	Returns whether or not the destination has requested to process the control or not.
float	GetValue()	Returns sample value last reported by modulator.
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
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
bool	IsActive()	Returns whether or not destination references an active modulator
void	ProcessControl ( const float*__restrict InBuffe..., int32 InNumSamples )	Processes output buffer by modulating the input buffer of base (i.e. carrier) values (in unit space).
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.
void	UpdateModulator ( const USoundModulatorBase* InM... )

Operators

		Name	Description
	FModulationD...	operator= ( const FModulationDestination& InMo... )
	FModulationD...	operator= ( FModulationDestination&& InModulat... )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss