Navigation
API > API/Plugins > API/Plugins/AudioModulation
References
| Module | AudioModulation |
| Header | /Engine/Plugins/Runtime/AudioModulation/Source/AudioModulation/Public/SoundModulationGenerator.h |
| Include | #include "SoundModulationGenerator.h" |
Syntax
class IGenerator
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
Audio::FDeviceId | AudioDeviceId |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
~IGenerator () |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | AudioRenderThreadCommand
(
TUniqueFunction< void()>&& InCommand |
|
  |
FGeneratorPtr | Clone () |
Clone the generator. |
  |
void | GetDebugCategories
(
TArray< FString >& OutDebugCategories |
|
  |
const FString & | GetDebugName () |
Required for instance look-up in factory registration. |
  |
void | GetDebugValues
(
TArray< FString >& OutDebugValues |
|
  |
float | GetValue () |
Returns current value of the generator. |
  |
void | Init
(
Audio::FDeviceId InDeviceId |
(Optional) Initializer step where the generator is provided the associated parent AudioDevice's Id. |
  |
bool | IsBypassed () |
Returns whether or not the generator is bypassed. |
 |
void | PumpCommands () |
Pumps commands from Audio Thread to the generator's modulation processing thread. |
 |
void | Update
(
double InElapsed |
Updates the generators value at the audio block rate on the modulation processing thread. |
 |
void | UpdateGenerator
(
FGeneratorPtr&& InGenerator |
Allows child generator class to override default copy/update behavior when receiving an updated generator call from the audio thread. |