Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Sound
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/Sound/SoundModulationDestination.h |
| Include | #include "Sound/SoundModulationDestination.h" |
Syntax
struct FModulationDestination
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
|||
 |
FModulationDestination
(
const FModulationDestination& InModulationDestination |
||
 |
FModulationDestination
(
FModulationDestination&& InModulationDestination |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
const FAlignedFloatBuffer & | GetBuffer () |
Returns buffer of interpolated modulation values. |
  |
bool | Returns whether or not the destination has requested to process the control or not. | |
  |
float | GetValue () |
Returns sample value last reported by modulator. |
 |
void | 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 | 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 |
 |
bool | ProcessControl
(
float InValueUnitBase, |
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 | UpdateModulators
(
const TSet< TObjectPtr< USoundModulatorBase >>& InModulators |
|
 |
void | UpdateModulators
(
const TSet< USoundModulatorBase* >& InModulators |
|
 |
void | UpdateModulators
(
const TSet< const USoundModulatorBase* >& InModulators |
Operators
| Type | Name | Description | |
|---|---|---|---|
 |
FModulationDestination & | operator=
(
const FModulationDestination& InModulationDestination |
|
 |
FModulationDestination & | operator=
(
FModulationDestination&& InModulationDestination |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | UpdateModulator
(
const USoundModulatorBase* InModulator |
Deprecated in favor of supporting multiple modulators per destination. Use 'UpdateModulators' instead. |