1. Epic GamesDeveloper
  3. UModularSynthComponent

UModularSynthComponent

[UModularSynthComponent](API\Plugins\Synthesis\UModularSynthComponent) Implementation of a USynthComponent.

API > API/Plugins > API/Plugins/Synthesis

UModularSynthComponent Implementation of a USynthComponent.

   
Name UModularSynthComponent
Type class
Header File /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SynthComponents/EpicSynth1Component.h
Include Path #include "SynthComponents/EpicSynth1Component.h"

Syntax

UCLASS (MinimalAPI, ClassGroup=Synth, Meta=(BlueprintSpawnableComponent))  
class UModularSynthComponent : public USynthComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UModularSynthComponent ( const FObjectInitializer& ObjectInitializer
)

   SynthComponents/EpicSynth1Component.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
VoiceCount int32 The voice count to use for the synthesizer. Cannot be changed. SynthComponents/EpicSynth1Component.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Synth|VoiceCount"
  • Meta=(ClampMin="1", ClampMax="32")

Functions

Public

Name Remarks Include Path Unreal Specifiers

FPatchId CreatePatch ( const ESynth1PatchSource PatchSource,
const TArray< FSynth1PatchCable >& PatchCables,
const bool bEnableByDefault
)

 Creates a new modular synth patch between a modulation source and a set of modulation destinations. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void NoteOff ( const float Note,
const bool bAllNotesOff,
const bool bKillAllNotes
)

 Stop the note (will only do anything if a voice is playing with that note) SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void NoteOn ( const float Note,
const int32 Velocity,
const float Duration
)

 Play a new note. Optionally pass in a duration to automatically turn off the note. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetAttackTime ( float AttackTimeMsec
)

 Sets the envelope attack time in msec. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetChorusDepth ( float Depth
)

 Sets the chorus depth. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetChorusEnabled ( bool EnableChorus
)

 Sets whether or not chorus is enabled. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetChorusFeedback ( float Feedback
)

 Sets the chorus feedback. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetChorusFrequency ( float Frequency
)

 Sets the chorus frequency. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetDecayTime ( float DecayTimeMsec
)

 Sets the envelope decay time in msec. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetEnableLegato ( bool LegatoEnabled
)

 Sets whether or not to use legato for the synthesizer. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

bool SetEnablePatch ( const FPatchId PatchId,
const bool bIsEnabled
)

   SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetEnablePolyphony ( bool bEnablePolyphony
)

 Sets whether or not to use polyphony for the synthesizer. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetEnableRetrigger ( bool RetriggerEnabled
)

 Sets whether or not to retrigger envelope per note on. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetEnableUnison ( bool EnableUnison
)

 Sets whether or not the synth is in unison mode (i.e. no spread) SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFilterAlgorithm ( ESynthFilterAlgorithm FilterAlgorithm
)

 Sets the filter algorithm. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFilterFrequency ( float FilterFrequencyHz
)

 Sets the filter cutoff frequency in hz. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFilterFrequencyMod ( float FilterFrequencyHz
)

 Sets the filter cutoff frequency in hz. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFilterQ ( float FilterQ
)

 Sets the filter Q (resonance) SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFilterQMod ( float FilterQ
)

 Sets a modulated filter Q (resonance) SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFilterType ( ESynthFilterType FilterType
)

 Sets the filter type. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetGainDb ( float GainDb
)

 Sets the synth gain in decibels. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"
  • Meta=(DisplayName="Set Gain (dB)")

void SetLFOFrequency ( int32 LFOIndex,
float FrequencyHz
)

 Sets the LFO frequency in hz SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetLFOFrequencyMod ( int32 LFOIndex,
float FrequencyModHz
)

 Sets the LFO frequency modulation in hz SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetLFOGain ( int32 LFOIndex,
float Gain
)

 Sets the LFO gain factor SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetLFOGainMod ( int32 LFOIndex,
float GainMod
)

 Sets the LFO gain mod factor (external modulation) SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetLFOMode ( int32 LFOIndex,
ESynthLFOMode LFOMode
)

 Sets the LFO type SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetLFOPatch ( int32 LFOIndex,
ESynthLFOPatchType LFOPatchType
)

 Sets the LFO patch type. LFO patch determines what parameter is modulated by the LFO. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetLFOType ( int32 LFOIndex,
ESynthLFOType LFOType
)

 Sets the LFO type SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetModEnvAttackTime ( const float AttackTimeMsec
)

 Sets the envelope modulator attack time in msec. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetModEnvBiasInvert ( const bool bInvert
)

 Sets whether or not to invert the bias output of the envelope modulator. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetModEnvBiasPatch ( const ESynthModEnvBiasPatch InPatchType
)

 Sets whether or not to modulate a param based on the envelope. Uses bias envelope output (offset from sustain gain). SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetModEnvDecayTime ( const float DecayTimeMsec
)

 Sets the envelope modulator attack time in msec. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetModEnvDepth ( const float Depth
)

 Sets the envelope modulator depth (amount to apply the output modulation) SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetModEnvInvert ( const bool bInvert
)

 Sets whether or not to invert the envelope modulator. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetModEnvPatch ( const ESynthModEnvPatch InPatchType
)

 Sets whether or not to modulate a param based on the envelope. Uses bias envelope output (offset from sustain gain). SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetModEnvReleaseTime ( const float Release
)

 Sets the envelope modulator release. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetModEnvSustainGain ( const float SustainGain
)

 Sets the envelope modulator sustain gain. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetOscCents ( int32 OscIndex,
float Cents
)

 Sets the oscillator cents. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetOscFrequencyMod ( int32 OscIndex,
float OscFreqMod
)

 Set the oscillator frequency modulation SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetOscGain ( int32 OscIndex,
float OscGain
)

 Set the oscillator gain. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetOscGainMod ( int32 OscIndex,
float OscGainMod
)

 Set the oscillator gain modulation. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetOscOctave ( int32 OscIndex,
float Octave
)

 Sets the oscillator octaves SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetOscPulsewidth ( int32 OscIndex,
float Pulsewidth
)

 Sets the square wave pulsewidth [0.0, 1.0]. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetOscSemitones ( int32 OscIndex,
float Semitones
)

 Sets the oscillator semitones. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetOscSync ( const bool bIsSynced
)

 Set whether or not to follow the phase of osc2 to osc1. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetOscType ( int32 OscIndex,
ESynth1OscType OscType
)

 Set the oscillator type. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetPan ( float Pan
)

 Sets the pan of the synth [-1.0, 1.0]. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetPitchBend ( float PitchBend
)

 Sets the synth pitch bend amount. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetPortamento ( float Portamento
)

 Sets the synth portamento [0.0, 1.0]. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetReleaseTime ( float ReleaseTimeMsec
)

 Sets the envelope release time in msec. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetSpread ( float Spread
)

 Sets the amount of spread of the oscillators. [0.0, 1.0]. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetStereoDelayFeedback ( float DelayFeedback
)

 Sets the amount of stereo delay feedback [0.0, 1.0]. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetStereoDelayIsEnabled ( bool StereoDelayEnabled
)

 Sets whether not stereo delay is enabled. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetStereoDelayMode ( ESynthStereoDelayMode StereoDelayMode
)

 Sets whether not stereo delay is enabled. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetStereoDelayRatio ( float DelayRatio
)

 Sets the amount of stereo delay ratio between left and right delay lines [0.0, 1.0]. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetStereoDelayTime ( float DelayTimeMsec
)

 Sets the amount of stereo delay time in msec. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetStereoDelayWetlevel ( float DelayWetlevel
)

 Sets the amount of stereo delay wetlevel [0.0, 1.0]. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetSustainGain ( float SustainGain
)

 Sets the envelope sustain gain value. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetSynthPreset ( const FModularSynthPreset& SynthPreset
)

 Sets the preset struct for the synth. SynthComponents/EpicSynth1Component.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page