1. Epic GamesDeveloper
  3. FEpicSynth1

FEpicSynth1

Unreal Engine C++ API Reference > Plugins > Synthesis

References

   
Module Synthesis
Header /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Public/EpicSynth1.h
Include #include "EpicSynth1.h"

Syntax

class FEpicSynth1

Variables

  Type Name Description
Protected variable float BaseFilterFreq Filter data.
Protected variable float BaseFilterQ  
Protected variable bool: 1 bIsChorusEnabled  
Protected variable bool: 1 bIsStereoEnabled  
Protected variable bool: 1 bIsUnison  
Protected variable FChorus Chorus  
Protected variable int32 ControlSamplePeriod The number of real samples per control rate tick.
Protected variable float ControlSampleRate Control sample rate (LFOs, etc)
Protected variable ESynthFilterAlgorithm FilterAlgorithm  
Protected variable float FilterFreqMod  
Protected variable float FilterQMod  
Protected variable EFilter::Type FilterType  
Protected variable TArray< int32 > FreeVoices List of free voice indices.
Protected variable uint32 LastMidiNote Last midi note played, used for portamento.
Protected variable FEpicSynth1Voice * LastVoice The last played voice.
Protected variable int32 MaxNumVoices The max number of voices allowed in the synth.
Protected variable FModulationMatrix ModMatrix Mod matrix object (used to route connections)
Protected variable int32 NumActiveVoices Count of number of voices in flight. Should not be greater than NumVoices.
Protected variable int32 NumStoppingVoices Number of buffer voices used for stopping voices.
Protected variable int32 NumVoices The current number of voices, may be less than MaxNumVoices.
Protected variable float Portamento Time to pitch shift up or down to target notes.
Protected variable float SampleRate Sample rate of the synth.
Protected variable FDelayStereo StereoDelay Stereo delay effect.
Protected variable uint32 VoiceGeneration An incremented number used to track voice age. Older voices have smaller generation counts.
Protected variable TArray< FEpicSynth1Voice * > Voices The allocated voice pool.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void  
Public function FPatchId

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

  
Public function void

GenerateFrame ( float* OutFrame
)

 Generate the next frame of audio.
Protected function uint32  
Public function void

Init ( const float InSampleRate,
const int32 InMaxVoices
)

  
Public function void

NoteOff ( const uint32 InMidiNote,
const bool bAllNotesOff,
const bool bKillAllNotes
)

 Turns the note off (triggers release envelope)
Public function void

NoteOn ( const uint32 InMidiNote,
const float InVelocity,
const float Duration
)

 Plays a note with the given midi note and midi velocity.
Public function void

SetChorusDepth ( const EChorusDelays::Type InType,
const float InDepth
)

  
Public function void

SetChorusEnabled ( const bool bInIsChorusEnabled
)

 Chorus parameters.
Public function void

SetChorusFeedback ( const EChorusDelays::Type InType,
const float InFeedback
)

  
Public function void

SetChorusFrequency ( const EChorusDelays::Type InType,
const float InFrequency
)

  
Public function bool

SetEnablePatch ( const FPatchId PatchId,
bool bIsEnabled
)

  
Public function void

SetEnvAttackTime ( const float InAttackTimeMsec
)

 Envelope setting.
Public function void

SetEnvDecayTime ( const float InDecayTimeMsec
)

  
Public function void

SetEnvLegatoEnabled ( const bool bIsLegatoEnabled
)

  
Public function void

SetEnvReleaseTime ( const float InReleaseTimeMsec
)

  
Public function void

SetEnvRetriggerMode ( const bool bIsRetriggerMode
)

  
Public function void

SetEnvSustainGain ( const float InSustainGain
)

  
Public function void

SetFilterAlgorithm ( const ESynthFilterAlgorithm FilterAlgorithm
)

 Filter setting.
Public function void

SetFilterFrequency ( const float InFilterFrequency
)

  
Public function void

SetFilterFrequencyMod ( const float InFilterFrequencyModulation
)

  
Public function void

SetFilterQ ( const float InFilterQ
)

  
Public function void

SetFilterQMod ( const float InFilterQModulation
)

  
Public function void

SetFilterType ( const EFilter::Type FilterType
)

  
Public function void

SetGainDb ( const float InGainDb
)

  
Public function void

SetLFOFrequency ( const int32 LFOIndex,
const float InLFOFrequency
)

  
Public function void

SetLFOFrequencyMod ( const int32 LFOIndex,
const float InLFOFrequencyMod
)

  
Public function void

SetLFOGain ( const int32 LFOIndex,
const float InLFOGain
)

  
Public function void

SetLFOGainMod ( const int32 LFOIndex,
const float InLFOGainMod
)

  
Public function void

SetLFOMode ( const int32 LFOIndex,
const ELFOMode::Type InLFOMode
)

  
Public function void

SetLFOPatch ( const int32 LFOIndex,
const ESynthLFOPatchType InRouteType
)

  
Public function void

SetLFOPulseWidth ( const int32 LFOIndex,
const float InPulseWidth
)

  
Public function void

SetLFOType ( const int32 LFOIndex,
const ELFO::Type InLFOType
)

 LFO setting.
Public function void

SetModEnvAttackTime ( const float InAttackTimeMsec
)

  
Public function void

SetModEnvBiasInvert ( const bool bInInvert
)

  
Public function void  
Public function void

SetModEnvDecayTime ( const float InDecayTimeMsec
)

  
Public function void

SetModEnvDepth ( const float InDepth
)

  
Public function void

SetModEnvInvert ( const bool bInInvert
)

  
Public function void

SetModEnvPatch ( const ESynthModEnvPatch InPatchType
)

 Modulation Envelope Setting.
Public function void

SetModEnvReleaseTime ( const float InReleaseTimeMsec
)

  
Public function void

SetModEnvSustainGain ( const float InSustainGain
)

  
Public function void

SetMonoMode ( const bool bIsMono
)

 Set the synth to be in mono mode.
Public function void

SetOscCents ( const int32 InOscIndex,
const float InCents
)

  
Public function void

SetOscDetune ( const int32 InOscIndex,
const float InDetuneFreq
)

  
Public function void

SetOscGain ( const int32 InOscIndex,
const float InGain
)

  
Public function void

SetOscGainMod ( const int32 InOscIndex,
const float InGain
)

  
Public function void

SetOscOctave ( const int32 InOscIndex,
const float InOctave
)

  
Public function void

SetOscPitchBend ( const int32 InOscIndex,
const float InPitchBend
)

  
Public function void

SetOscPortamento ( const float InPortamento
)

  
Public function void

SetOscPulseWidth ( const int32 InOscIndex,
const float InPulseWidth
)

  
Public function void

SetOscSemitones ( const int32 InOscIndex,
const float InSemitones
)

  
Public function void

SetOscSpread ( const float InSpread
)

  
Public function void

SetOscSync ( const bool bIsSync
)

  
Public function void

SetOscType ( const int32 InOscIndex,
const EOsc::Type InOscType
)

 Oscillator setting.
Public function void

SetOscUnison ( const bool bInUnison
)

  
Public function void

SetPan ( const float InPan
)

 Pan and gain setting.
Public function void

SetStereoDelayFeedback ( const float InDelayFeedback
)

  
Public function void

SetStereoDelayIsEnabled ( const bool bInIsStereoEnabled
)

 Stereo Delay parameters.
Public function void  
Public function void

SetStereoDelayRatio ( const float InDelayRatio
)

  
Public function void

SetStereoDelayTimeMsec ( const float InDelayTimeMsec
)

  
Public function void

SetStereoDelayWetLevel ( const float InDelayWetLevel
)

  
Protected function void  
Protected function void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page