Navigation
API > API/Runtime > API/Runtime/SignalProcessing
Class representing a grain of audio.
| Name | FGrain |
| Type | class |
| Header File | /Engine/Source/Runtime/SignalProcessing/Public/DSP/Granulator.h |
| Include Path | #include "DSP/Granulator.h" |
Syntax
class FGrain
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FGrain
(
const int32 InGrainId, |
DSP/Granulator.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FGrain() |
DSP/Granulator.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GenerateFrame
(
float* OutStereoFrame |
Generates the next frame from the grain. | DSP/Granulator.h | |
bool IsDone() |
Queries if this grain is finished playing and needs to be reaped. | DSP/Granulator.h | |
void Play
(
const FGrainData& InGrainData |
Plays the grain with the supplied grain data. | DSP/Granulator.h | |
void SetDurationScale
(
const float InDurationScale |
Changes how quickly the grain reads through envelope. | DSP/Granulator.h | |
void SetOscFrequency
(
const float InFrequency |
Sets the oscillator frequency. | DSP/Granulator.h | |
void SetOscFrequencyModuation
(
const float InFrequencyModulation |
Sets the oscillator frequency modulation. | DSP/Granulator.h | |
void SetOscType
(
const EOsc::Type InType |
Changes the oscillator type for the grain (if the grain is in synth mode) | DSP/Granulator.h | |
void SetPanModulation
(
const float InPanModulation |
Sets the pan modulation angle. | DSP/Granulator.h | |
void SetPitchModulation
(
const float InPitchModulation |
Sets the grain pitch modulation. | DSP/Granulator.h | |
void SetVolumeModulation
(
const float InVolumeModulation |
Sets the grain modulation. | DSP/Granulator.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetEnvelopeValue() |
DSP/Granulator.h |