Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FGrain

Class representing a grain of audio.

Windows

MacOS

Linux

References

Module	SignalProcessing
Header	/Engine/Source/Runtime/SignalProcessing/Public/DSP/Granulator.h
Include	#include "DSP/Granulator.h"

Syntax

class FGrain

Remarks

Class representing a grain of audio.

Variables

	Name	Description
float	CurrentFrameCount	The current frame count the grain is on.
float	CurrentFrequency	Current frequency.
float	CurrentPan	The current pan.
float	CurrentPitch	The current pitch.
float	CurrentVolumeScale	The current volume scale.
float	DurationScale	How quickly we read through the envelope.
float	EndFrameCount	The end frame count the grain will finish on.
TArray< float >	FrameScratch	Scratch buffer for sample reading.
FGrainData	GrainData	Grain data struct.
int32	GrainId	Grain id.
FOsc	Osc	Oscillator to use for synthesis mode.
FGranularSynth ...	Parent	Parent synth.
FSampleBufferRe...	SampleBufferReader	The sample buffer reader to use for the grain of the mode is granulation.
TArray< float >	SpeakerMap	Speaker map based on the current grain azimuth.

Constructors

	Name	Description
	FGrain ( const int32 InGrainId, FGranularSynth* InParent )

Destructors

	Name	Description
	~FGrain()

Functions

	Name	Description
bool	GenerateFrame ( float* OutStereoFrame )	Generates the next frame from the grain.
float	GetEnvelopeValue()
bool	IsDone()	Queries if this grain is finished playing and needs to be reaped.
void	Play ( const FGrainData& InGrainData )	Plays the grain with the supplied grain data.
void	SetDurationScale ( const float InDurationScale )	Changes how quickly the grain reads through envelope.
void	SetOscFrequency ( const float InFrequency )	Sets the oscillator frequency.
void	SetOscFrequencyModuation ( const float InFrequencyModulation )	Sets the oscillator frequency modulation.
void	SetOscType ( const EOsc::Type InType )	Changes the oscillator type for the grain (if the grain is in synth mode)
void	SetPanModulation ( const float InPanModulation )	Sets the pan modulation angle.
void	SetPitchModulation ( const float InPitchModulation )	Sets the grain pitch modulation.
void	SetVolumeModulation ( const float InVolumeModulation )	Sets the grain modulation.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss