Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Plugins > AudioModulation > IGenerator

Light Theme

Dark Theme

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
	Audio::FDeviceI...	AudioDeviceId

Destructors

	Name	Description
	~IGenerator()

Functions

		Name	Description
	void	AudioRenderThreadCommand ( TUniqueFunction< void()>&& InComma... )
	FGeneratorPt...	Clone()	Clone the generator.
	void	GetDebugCategories ( TArray< FString >& OutDebugCategor... )
	const FStrin...	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.