Module |
|
Header |
/Engine/Source/Runtime/SignalProcessing/Public/DSP/Granulator.h |
Include |
#include "DSP/Granulator.h" |
class FGranularSynth
A stereo granulator.
Name | Description | ||
---|---|---|---|
|
ActiveGrains |
||
|
Amp |
||
|
bScrubMode |
||
|
float |
CurrentPlayHeadFrame |
The current playhead frame. |
|
CurrentSpawnFrameCount |
The current number of frames since last attempt to spawn. |
|
|
DeadGrains |
||
|
Duration |
||
|
DynamicsProcessor |
||
|
FreeGrains |
||
|
Frequency |
||
|
GainEnv |
Overall envelope of the granulator. |
|
|
GrainEnvelope |
The single envelope function used by all grains. |
|
|
GrainEnvelopeType |
Current grain envelope type. |
|
|
GrainOscType |
The oscillator type to use if in synthesis mode. |
|
|
GrainPool |
A pool of free grains. Will dynamically grow to needed grains based on grain density. |
|
|
float |
GrainProbability |
The probability of a grain occurring when it tries to spawn (based off the GrainsPerSecond) |
|
float |
GrainsPerSecond |
The rate at which grains are spawned. |
|
Mode |
What mode the granular synthesizer is in. |
|
|
NextSpawnFrame |
The next frame when a grain needs to spawn. |
|
|
NoteDurationFrameCount |
Counts for overall note duration of the granulator. |
|
|
NoteDurationFrameEnd |
||
|
NumActiveGrains |
||
|
NumChannels |
||
|
Pan |
||
|
Pitch |
||
|
float |
PlaybackSpeed |
|
|
TSampleBuffer< ... |
SampleBuffer |
The buffer which holds the sample to be granulated. |
|
SampleRate |
||
|
SeekingPlayheadTimeFrame |
||
|
Volume |
Name | Description | |
---|---|---|
|
FGranularSynth() |
Name | Description | |
---|---|---|
|
~FGranularSynth() |
Name | Description | ||
---|---|---|---|
|
Generate ( |
Generate the next audio buffer. |
|
|
float |
GetCurrentPlayheadTime() |
Get current playback time (in granular mode) |
|
GetNumActiveGrains() |
Return the number of currently active grains. |
|
|
float |
GetSampleDuration() |
Returns the duration of the internal loaded sample buffer. |
|
float |
GetWrappedPlayheadPosition ( |
Return wrapped playhead position. |
|
Init |
||
|
LoadSampleBuffer ( |
Loads a sound wave to use for granular synth mode. |
|
|
NoteOff |
Note off, triggers release envelope. |
|
|
NoteOn ( |
Plays a granular synthesis "Note". |
|
|
SeekTime ( |
Seeks the loaded buffer used for granulation. Grains will spawn from this location. |
|
|
SetAttackTime ( |
Sets the granular synth attack time. |
|
|
SetDecayTime ( |
Sets the granular synth decay time. |
|
|
SetGrainDuration ( |
Sets the grain duration. |
|
|
SetGrainDurationScale ( |
Sets the grain duration modulation. |
|
|
SetGrainEnvelopeType ( |
Sets the envelope type to use for new grains. Will instantly switch all grains to this envelope type so may cause discontinuities if switched while playing. |
|
|
SetGrainFrequency ( |
Sets the grain frequency. |
|
|
SetGrainFrequencyModulation ( |
Sets the grain frequency modulation. |
|
|
SetGrainOscType ( |
Sets the grain oscillator type (for use with granular synthesis mode) |
|
|
SetGrainPan ( |
Sets the grain azimuth (pan) and randomization range. |
|
|
SetGrainPanModulation ( |
Sets the grain azimuth modulation - allows modulating actively playing grain azimuths. |
|
|
SetGrainPitch ( |
Sets the base grain pitch and randomization range. |
|
|
SetGrainPitchModulation ( |
Sets the grain pitch modulation allows modulating actively playing grain pitches. |
|
|
SetGrainProbability ( |
The probability at which a grain will occur when a grain tries to spawn. Allows for sporatic grain generation. |
|
|
SetGrainsPerSecond ( |
The rate at which new grains are attempted to be spawned. |
|
|
SetGrainVolume ( |
Sets the base grain volume and randomization range. |
|
|
SetGrainVolumeModulation ( |
Sets the grain modulation allows modulating actively playing grain volumes. |
|
|
SetPlaybackSpeed ( |
Sets how fast the granular play head for granulation is is played (and in what direction) |
|
|
SetReleaseTime ( |
Sets the granular synth releas etime. |
|
|
SetScrubMode ( |
Sets whether or not the buffer playback advances on its own or if it just sits in one place. |
|
|
SetSustainGain ( |
Sets the granular synth sustain gain. |
|
|
SpawnGrain() |
Spawns grains. |
Name |
Description |
|
---|---|---|
|
FGrainParam |
Current grain azimuth modulation. |