IGenerator

Choose your operating system:

Windows

macOS

Linux

References

Module

AudioModulation

Header

/Engine/Plugins/Runtime/AudioModulation/Source/AudioModulation/Public/SoundModulationGenerator.h

Include

#include "SoundModulationGenerator.h"

Syntax

class IGenerator

Variables

Name Description

Protected variable

Audio::FDeviceI...

 

AudioDeviceId

Destructors

Name Description

Public function Virtual

~IGenerator()

Functions

Name Description

Protected function

void

 

AudioRenderThreadCommand

(
    TUniqueFunction< void()>&& InComma...
)

Public function Const

FGeneratorPt...

 

Clone()

Clone the generator.

Public function Const

void

 

GetDebugCategories

(
    TArray< FString >& OutDebugCategor...
)

Public function Const

const FStrin...

 

GetDebugName()

Required for instance look-up in factory registration.

Public function Const

void

 

GetDebugValues

(
    TArray< FString >& OutDebugValues
)

Public function Const

float

 

GetValue()

Returns current value of the generator.

Public function Virtual

void

 

Init

(
    Audio::FDeviceId InDeviceId
)

(Optional) Initializer step where the generator is provided the associated parent AudioDevice's Id.

Public function Const

bool

 

IsBypassed()

Returns whether or not the generator is bypassed.

Public function

void

 

PumpCommands()

Pumps commands from Audio Thread to the generator's modulation processing thread.

Public function

void

 

Update

(
    double InElapsed
)

Updates the generators value at the audio block rate on the modulation processing thread.

Public function

void

 

UpdateGenerator

(
    FGeneratorPtr&& InGenerator
)

Allows child generator class to override default copy/update behavior when receiving an updated generator call from the audio thread.