UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::FGrain Class Reference

#include <Granulator.h>

Public Member Functions

SIGNALPROCESSING_API FGrain (const int32 InGrainId, FGranularSynth *InParent)
 
SIGNALPROCESSING_API ~FGrain ()
 
SIGNALPROCESSING_API void Play (const FGrainData &InGrainData)
 
SIGNALPROCESSING_API void SetOscType (const EOsc::Type InType)
 
SIGNALPROCESSING_API void SetOscFrequency (const float InFrequency)
 
SIGNALPROCESSING_API void SetOscFrequencyModuation (const float InFrequencyModulation)
 
SIGNALPROCESSING_API void SetPitchModulation (const float InPitchModulation)
 
SIGNALPROCESSING_API void SetVolumeModulation (const float InVolumeModulation)
 
SIGNALPROCESSING_API void SetPanModulation (const float InPanModulation)
 
SIGNALPROCESSING_API void SetDurationScale (const float InDurationScale)
 
SIGNALPROCESSING_API bool IsDone () const
 
SIGNALPROCESSING_API bool GenerateFrame (float *OutStereoFrame)
 

Protected Member Functions

SIGNALPROCESSING_API float GetEnvelopeValue ()
 

Protected Attributes

int32 GrainId
 
FGranularSynthParent
 
FGrainData GrainData
 
FSampleBufferReader SampleBufferReader
 
FOsc Osc
 
float CurrentPitch
 
float CurrentFrequency
 
float CurrentVolumeScale
 
float CurrentPan
 
float DurationScale
 
float CurrentFrameCount
 
float EndFrameCount
 
TArray< floatSpeakerMap
 
TArray< floatFrameScratch
 

Constructor & Destructor Documentation

◆ FGrain()

Audio::FGrain::FGrain ( const int32  InGrainId,
FGranularSynth InParent 
)

◆ ~FGrain()

Audio::FGrain::~FGrain ( )

Member Function Documentation

◆ GenerateFrame()

bool Audio::FGrain::GenerateFrame ( float OutStereoFrame)

◆ GetEnvelopeValue()

float Audio::FGrain::GetEnvelopeValue ( )
protected

◆ IsDone()

bool Audio::FGrain::IsDone ( ) const

◆ Play()

void Audio::FGrain::Play ( const FGrainData InGrainData)

◆ SetDurationScale()

void Audio::FGrain::SetDurationScale ( const float  InDurationScale)

◆ SetOscFrequency()

void Audio::FGrain::SetOscFrequency ( const float  InFrequency)

◆ SetOscFrequencyModuation()

void Audio::FGrain::SetOscFrequencyModuation ( const float  InFrequencyModulation)

◆ SetOscType()

void Audio::FGrain::SetOscType ( const EOsc::Type  InType)

◆ SetPanModulation()

void Audio::FGrain::SetPanModulation ( const float  InPanModulation)

◆ SetPitchModulation()

void Audio::FGrain::SetPitchModulation ( const float  InPitchModulation)

◆ SetVolumeModulation()

void Audio::FGrain::SetVolumeModulation ( const float  InVolumeModulation)

Member Data Documentation

◆ CurrentFrameCount

float Audio::FGrain::CurrentFrameCount
protected

◆ CurrentFrequency

float Audio::FGrain::CurrentFrequency
protected

◆ CurrentPan

float Audio::FGrain::CurrentPan
protected

◆ CurrentPitch

float Audio::FGrain::CurrentPitch
protected

◆ CurrentVolumeScale

float Audio::FGrain::CurrentVolumeScale
protected

◆ DurationScale

float Audio::FGrain::DurationScale
protected

◆ EndFrameCount

float Audio::FGrain::EndFrameCount
protected

◆ FrameScratch

TArray<float> Audio::FGrain::FrameScratch
protected

◆ GrainData

FGrainData Audio::FGrain::GrainData
protected

◆ GrainId

int32 Audio::FGrain::GrainId
protected

◆ Osc

FOsc Audio::FGrain::Osc
protected

◆ Parent

FGranularSynth* Audio::FGrain::Parent
protected

◆ SampleBufferReader

FSampleBufferReader Audio::FGrain::SampleBufferReader
protected

◆ SpeakerMap

TArray<float> Audio::FGrain::SpeakerMap
protected

The documentation for this class was generated from the following files: