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