UModularSynthComponent

[UModularSynthComponent](API\Plugins\Synthesis\SynthComponents\UModularSynthComponent) Implementation of a [USynthComponent](API\Runtime\AudioMixer\Components\USynthComponent).

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Synthesis

Header

/Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SynthComponents/EpicSynth1Component.h

Include

#include "SynthComponents/EpicSynth1Component.h"

Syntax

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

Remarks

Variables

Name Description

Protected variable

Audio::FEpicSyn...

 

EpicSynth1

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

int32

 

VoiceCount

The voice count to use for the synthesizer. Cannot be changed.

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function UFunction BlueprintCallable, Category

FPatchId

 

CreatePatch

(
    const ESynth1PatchSource PatchSourc...,
    const TArray< FSynth1PatchCable >&...,
    const bool bEnableByDefault
)

Creates a new modular synth patch between a modulation source and a set of modulation destinations.

Public function UFunction BlueprintCallable, Category

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)

Public function UFunction BlueprintCallable, Category

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.

Public function UFunction BlueprintCallable, Category

void

 

SetAttackTime

(
    float AttackTimeMsec
)

Sets the envelope attack time in msec.

Public function UFunction BlueprintCallable, Category

void

 

SetChorusDepth

(
    float Depth
)

Sets the chorus depth.

Public function UFunction BlueprintCallable, Category

void

 

SetChorusEnabled

(
    bool EnableChorus
)

Sets whether or not chorus is enabled.

Public function UFunction BlueprintCallable, Category

void

 

SetChorusFeedback

(
    float Feedback
)

Sets the chorus feedback.

Public function UFunction BlueprintCallable, Category

void

 

SetChorusFrequency

(
    float Frequency
)

Sets the chorus frequency.

Public function UFunction BlueprintCallable, Category

void

 

SetDecayTime

(
    float DecayTimeMsec
)

Sets the envelope decay time in msec.

Public function UFunction BlueprintCallable, Category

void

 

SetEnableLegato

(
    bool LegatoEnabled
)

Sets whether or not to use legato for the synthesizer.

Public function UFunction BlueprintCallable, Category

bool

 

SetEnablePatch

(
    const FPatchId PatchId,
    const bool bIsEnabled
)

Public function UFunction BlueprintCallable, Category

void

 

SetEnablePolyphony

(
    bool bEnablePolyphony
)

Sets whether or not to use polyphony for the synthesizer.

Public function UFunction BlueprintCallable, Category

void

 

SetEnableRetrigger

(
    bool RetriggerEnabled
)

Sets whether or not to retrigger envelope per note on.

Public function UFunction BlueprintCallable, Category

void

 

SetEnableUnison

(
    bool EnableUnison
)

Sets whether or not the synth is in unison mode (i.e. no spread)

Public function UFunction BlueprintCallable, Category

void

 

SetFilterAlgorithm

(
    ESynthFilterAlgorithm FilterAlgorit...
)

Sets the filter algorithm.

Public function UFunction BlueprintCallable, Category

void

 

SetFilterFrequency

(
    float FilterFrequencyHz
)

Sets the filter cutoff frequency in hz.

Public function UFunction BlueprintCallable, Category

void

 

SetFilterFrequencyMod

(
    float FilterFrequencyHz
)

Sets the filter cutoff frequency in hz.

Public function UFunction BlueprintCallable, Category

void

 

SetFilterQ

(
    float FilterQ
)

Sets the filter Q (resonance)

Public function UFunction BlueprintCallable, Category

void

 

SetFilterQMod

(
    float FilterQ
)

Sets a modulated filter Q (resonance)

Public function UFunction BlueprintCallable, Category

void

 

SetFilterType

(
    ESynthFilterType FilterType
)

Sets the filter type.

Public function UFunction BlueprintCallable, Category

void

 

SetGainDb

(
    float GainDb
)

Sets the synth gain in decibels.

Public function UFunction BlueprintCallable, Category

void

 

SetLFOFrequency

(
    int32 LFOIndex,
    float FrequencyHz
)

Sets the LFO frequency in hz

Public function UFunction BlueprintCallable, Category

void

 

SetLFOFrequencyMod

(
    int32 LFOIndex,
    float FrequencyModHz
)

Sets the LFO frequency modulation in hz

Public function UFunction BlueprintCallable, Category

void

 

SetLFOGain

(
    int32 LFOIndex,
    float Gain
)

Sets the LFO gain factor

Public function UFunction BlueprintCallable, Category

void

 

SetLFOGainMod

(
    int32 LFOIndex,
    float GainMod
)

Sets the LFO gain mod factor (external modulation)

Public function UFunction BlueprintCallable, Category

void

 

SetLFOMode

(
    int32 LFOIndex,
    ESynthLFOMode LFOMode
)

Sets the LFO type

Public function UFunction BlueprintCallable, Category

void

 

SetLFOPatch

(
    int32 LFOIndex,
    ESynthLFOPatchType LFOPatchType
)

Sets the LFO patch type. LFO patch determines what parameter is modulated by the LFO.

Public function UFunction BlueprintCallable, Category

void

 

SetLFOType

(
    int32 LFOIndex,
    ESynthLFOType LFOType
)

Sets the LFO type

Public function UFunction BlueprintCallable, Category

void

 

SetModEnvAttackTime

(
    const float AttackTimeMsec
)

Sets the envelope modulator attack time in msec.

Public function UFunction BlueprintCallable, Category

void

 

SetModEnvBiasInvert

(
    const bool bInvert
)

Sets whether or not to invert the bias output of the envelope modulator.

Public function UFunction BlueprintCallable, Category

void

 

SetModEnvBiasPatch

(
    const ESynthModEnvBiasPatch InPatch...
)

Sets whether or not to modulate a param based on the envelope. Uses bias envelope output (offset from sustain gain).

Public function UFunction BlueprintCallable, Category

void

 

SetModEnvDecayTime

(
    const float DecayTimeMsec
)

Sets the envelope modulator attack time in msec.

Public function UFunction BlueprintCallable, Category

void

 

SetModEnvDepth

(
    const float Depth
)

Sets the envelope modulator depth (amount to apply the output modulation)

Public function UFunction BlueprintCallable, Category

void

 

SetModEnvInvert

(
    const bool bInvert
)

Sets whether or not to invert the envelope modulator.

Public function UFunction BlueprintCallable, Category

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).

Public function UFunction BlueprintCallable, Category

void

 

SetModEnvReleaseTime

(
    const float Release
)

Sets the envelope modulator release.

Public function UFunction BlueprintCallable, Category

void

 

SetModEnvSustainGain

(
    const float SustainGain
)

Sets the envelope modulator sustain gain.

Public function UFunction BlueprintCallable, Category

void

 

SetOscCents

(
    int32 OscIndex,
    float Cents
)

Sets the oscillator cents.

Public function UFunction BlueprintCallable, Category

void

 

SetOscFrequencyMod

(
    int32 OscIndex,
    float OscFreqMod
)

Set the oscillator frequency modulation

Public function UFunction BlueprintCallable, Category

void

 

SetOscGain

(
    int32 OscIndex,
    float OscGain
)

Set the oscillator gain.

Public function UFunction BlueprintCallable, Category

void

 

SetOscGainMod

(
    int32 OscIndex,
    float OscGainMod
)

Set the oscillator gain modulation.

Public function UFunction BlueprintCallable, Category

void

 

SetOscOctave

(
    int32 OscIndex,
    float Octave
)

Sets the oscillator octaves

Public function UFunction BlueprintCallable, Category

void

 

SetOscPulsewidth

(
    int32 OscIndex,
    float Pulsewidth
)

Sets the square wave pulsewidth [0.0, 1.0].

Public function UFunction BlueprintCallable, Category

void

 

SetOscSemitones

(
    int32 OscIndex,
    float Semitones
)

Sets the oscillator semitones.

Public function UFunction BlueprintCallable, Category

void

 

SetOscSync

(
    const bool bIsSynced
)

Set whether or not to slave the phase of osc2 to osc1.

Public function UFunction BlueprintCallable, Category

void

 

SetOscType

(
    int32 OscIndex,
    ESynth1OscType OscType
)

Set the oscillator type.

Public function UFunction BlueprintCallable, Category

void

 

SetPan

(
    float Pan
)

Sets the pan of the synth [-1.0, 1.0].

Public function UFunction BlueprintCallable, Category

void

 

SetPitchBend

(
    float PitchBend
)

Sets the synth pitch bend amount.

Public function UFunction BlueprintCallable, Category

void

 

SetPortamento

(
    float Portamento
)

Sets the synth portamento [0.0, 1.0].

Public function UFunction BlueprintCallable, Category

void

 

SetReleaseTime

(
    float ReleaseTimeMsec
)

Sets the envelope release time in msec.

Public function UFunction BlueprintCallable, Category

void

 

SetSpread

(
    float Spread
)

Sets the amount of spread of the oscillators. [0.0, 1.0].

Public function UFunction BlueprintCallable, Category

void

 

SetStereoDelayFeedback

(
    float DelayFeedback
)

Sets the amount of stereo delay feedback [0.0, 1.0].

Public function UFunction BlueprintCallable, Category

void

 

SetStereoDelayIsEnabled

(
    bool StereoDelayEnabled
)

Sets whether not stereo delay is enabled.

Public function UFunction BlueprintCallable, Category

void

 

SetStereoDelayMode

(
    ESynthStereoDelayMode StereoDelayMo...
)

Sets whether not stereo delay is enabled.

Public function UFunction BlueprintCallable, Category

void

 

SetStereoDelayRatio

(
    float DelayRatio
)

Sets the amount of stereo delay ratio between left and right delay lines [0.0, 1.0].

Public function UFunction BlueprintCallable, Category

void

 

SetStereoDelayTime

(
    float DelayTimeMsec
)

Sets the amount of stereo delay time in msec.

Public function UFunction BlueprintCallable, Category

void

 

SetStereoDelayWetlevel

(
    float DelayWetlevel
)

Sets the amount of stereo delay wetlevel [0.0, 1.0].

Public function UFunction BlueprintCallable, Category

void

 

SetSustainGain

(
    float SustainGain
)

Sets the envelope sustain gain value.

Public function UFunction BlueprintCallable, Category

void

 

SetSynthPreset

(
    const FModularSynthPreset& SynthPr...
)

Sets the preset struct for the synth.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback