Audio::FModulationDestination Struct Reference

#include <SoundModulationDestination.h>

Public Member Functions
	FModulationDestination ()=default
ENGINE_API	FModulationDestination (const FModulationDestination &InModulationDestination)
ENGINE_API	FModulationDestination (FModulationDestination &&InModulationDestination)
ENGINE_API FModulationDestination &	operator= (const FModulationDestination &InModulationDestination)
ENGINE_API FModulationDestination &	operator= (FModulationDestination &&InModulationDestination)
ENGINE_API void	Init (FDeviceId InDeviceId, bool bInIsBuffered=false, bool bInValueNormalized=false)
ENGINE_API void	Init (FDeviceId InDeviceId, FName InParameterName, bool bInIsBuffered=false, bool bInValueNormalized=false)
ENGINE_API bool	IsActive () const
ENGINE_API bool	ProcessControl (float InValueUnitBase, int32 InNumSamples=0)
ENGINE_API void	UpdateModulator (const USoundModulatorBase *InModulator)
ENGINE_API void	UpdateModulators (const TSet< TObjectPtr< USoundModulatorBase > > &InModulators)
ENGINE_API void	UpdateModulators (const TSet< USoundModulatorBase * > &InModulators)
ENGINE_API void	UpdateModulators (const TSet< const USoundModulatorBase * > &InModulators)
ENGINE_API void	ClearModulators ()
const FAlignedFloatBuffer &	GetBuffer () const
bool	GetHasProcessed () const
float	GetValue () const

Constructor & Destructor Documentation

FModulationDestination() [1/3]

Audio::FModulationDestination::FModulationDestination ( )

default

FModulationDestination() [2/3]

Audio::FModulationDestination::FModulationDestination

(

const FModulationDestination &

InModulationDestination

)

FModulationDestination() [3/3]

Audio::FModulationDestination::FModulationDestination

(

FModulationDestination &&

InModulationDestination

)

Member Function Documentation

ClearModulators()

void Audio::FModulationDestination::ClearModulators

(

)

GetBuffer()

const FAlignedFloatBuffer & Audio::FModulationDestination::GetBuffer ( ) const

inline

Returns buffer of interpolated modulation values. If not set to "IsBuffered" when initialized, returns an empty array.

GetHasProcessed()

bool Audio::FModulationDestination::GetHasProcessed ( ) const

inline

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

GetValue()

float Audio::FModulationDestination::GetValue ( ) const

inline

Returns sample value last reported by modulator. Returns value in unit space, unless 'ValueNormalized' option is set on initialization.

Init() [1/2]

void Audio::FModulationDestination::Init	(	FDeviceId	InDeviceId,
		bool	bInIsBuffered = false,
		bool	bInValueNormalized = false
	)

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

Init() [2/2]

void Audio::FModulationDestination::Init	(	FDeviceId	InDeviceId,
		FName	InParameterName,
		bool	bInIsBuffered = false,
		bool	bInValueNormalized = false
	)

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

IsActive()

bool Audio::FModulationDestination::IsActive

(

)

const

returns whether or not destination references an active modulator

operator=() [1/2]

FModulationDestination & Audio::FModulationDestination::operator=

(

const FModulationDestination &

InModulationDestination

)

operator=() [2/2]

FModulationDestination & Audio::FModulationDestination::operator=

(

FModulationDestination &&

InModulationDestination

)

ProcessControl()

bool Audio::FModulationDestination::ProcessControl	(	float	InValueUnitBase,
		int32	InNumSamples = 0
	)

UpdateModulator()

void Audio::FModulationDestination::UpdateModulator

(

const USoundModulatorBase *

InModulator

)

UpdateModulators() [1/3]

void Audio::FModulationDestination::UpdateModulators

(

const TSet< const USoundModulatorBase * > &

InModulators

)

UpdateModulators() [2/3]

void Audio::FModulationDestination::UpdateModulators

(

const TSet< TObjectPtr< USoundModulatorBase > > &

InModulators

)

UpdateModulators() [3/3]

void Audio::FModulationDestination::UpdateModulators

(

const TSet< USoundModulatorBase * > &

InModulators

)

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Engine/Classes/Sound/SoundModulationDestination.h
• Engine/Source/Runtime/Engine/Private/SoundModulationDestination.cpp