1. Epic GamesDeveloper
  3. USynthComponentMonoWaveTable

USynthComponentMonoWaveTable

API > API/Plugins > API/Plugins/Synthesis

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

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

USynthComponentMonoWaveTable ( const FObjectInitializer& ObjectInitializer
)

   SynthComponents/SynthComponentMonoWaveTable.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~USynthComponentMonoWaveTable()

 If in editor, unregister with the asset SynthComponents/SynthComponentMonoWaveTable.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnNumTablesChanged FNumTablesChanged Curve array altered. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintAssignable
  • Category="Synth|Preset"
OnTableAltered FOnTableAltered Wave Table curve was edited. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintAssignable
  • Category="Synth|Preset"

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetCurveTangent ( int32 TableIndex
)

 TODO: Enable this functionality when Curve bug is fixed. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

TArray< float > GetKeyFrameValuesForTable ( float TableIndex
) const

 Get an array of floats that represent the key frames in the requested curve. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

int32 GetMaxTableIndex()

 Get the number of curves in the wave table. (returns -1 if there is no asset) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

int32 GetNumTableEntries()

 Get the number of table elements from Blueprint. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void NoteOff ( const float InMidiNote
)

 Starts a new note (retrigs modulators, etc.) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void NoteOn ( const float InMidiNote,
const float InVelocity
)

 Starts a new note (retrigs modulators, etc.) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void RefreshAllWaveTables()

 Refresh all wavetables (from Game Thread data) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void RefreshWaveTable ( int32 Index
)

 Refresh a particular wavetable (from Game Thread data) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetAmpEnvelopeAttackTime ( const float InAttackTimeMsec
)

 Set Amp envelope attack time (msec) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetAmpEnvelopeBiasDepth ( const float InDepth
)

 Set the bias depth of the the Amp envelope. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetAmpEnvelopeBiasInvert ( const bool bInBiasInvert
)

 Set whether or not the Amp envelope's bias is inverted. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetAmpEnvelopeDecayTime ( const float InDecayTimeMsec
)

 Set Amp envelope decay time (msec) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetAmpEnvelopeDepth ( const float InDepth
)

 Set the overall depth of the Amp envelope. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetAmpEnvelopeInvert ( const bool bInInvert
)

 Set whether or not the Amp envelope is inverted. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetAmpEnvelopeReleaseTime ( const float InReleaseTimeMsec
)

 Set Amp envelope release time (msec) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetAmpEnvelopeSustainGain ( const float InSustainGain
)

 Set Amp envelope sustain gain [0.0, 1.0]. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

bool SetCurveInterpolationType ( CurveInterpolationType InterpolationType,
int32 TableIndex
)

 Set the curve interpolation type (What the curve is doing between keyframes) This should only be used for live-editing features! (changing the curves at runtime is expensive) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

bool SetCurveTangent ( int32 TableIndex,
float InNewTangent
)

 Set the curve tangent ("Curve depth" between keyframes) This should only be used for live-editing features! (changing the curves at runtime is expensive) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

bool SetCurveValue ( int32 TableIndex,
int32 KeyframeIndex,
const float NewValue
)

 Set a Keyframe value given a Table number and Keyframe number. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFilterEnvelopeAttackTime ( const float InAttackTimeMsec
)

 Set Low-Pass Filter envelope attack time (msec) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFilterEnvelopeBiasDepth ( const float InDepth
)

 Set Low-Pass Filter envelope bias depth. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFilterEnvelopeBiasInvert ( const bool bInBiasInvert
)

 Set Low-Pass Filter envelope bias inversion. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFilterEnvelopeDepth ( const float InDepth
)

 Set Low-Pass Filter envelope depth. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFilterEnvelopeInvert ( const bool bInInvert
)

 Set Low-Pass Filter envelope inversion. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFilterEnvelopenDecayTime ( const float InDecayTimeMsec
)

 Set Low-Pass Filter envelope decay time (msec) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFilterEnvelopeReleaseTime ( const float InReleaseTimeMsec
)

 Set Low-Pass Filter envelope release time (msec) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFilterEnvelopeSustainGain ( const float InSustainGain
)

 Set Low-Pass Filter envelope sustain gain. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFrequency ( const float FrequencyHz
)

 Sets the oscillator's frequency. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFrequencyPitchBend ( const float FrequencyOffsetCents
)

 Set a frequency offset in cents (for pitch modulation such as the Pitch Bend Wheel) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetFrequencyWithMidiNote ( const float InMidiNote
)

 Set the oscillator's frequency via midi note number. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

virtual void SetLowPassFilterFrequency ( float InLowPassFilterFrequency
)

   SynthComponents/SynthComponentMonoWaveTable.h  

void SetLowPassFilterResonance ( float InNewQ
)

 Set the Cut-off frequency of the low-pass filter. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"
  • Meta=(ClampMin="0.0", ClampMax="10.0")

void SetPositionEnvelopeAttackTime ( const float InAttackTimeMsec
)

 Set Position envelope attack time (msec) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetPositionEnvelopeBiasDepth ( const float InDepth
)

 Set Position envelope bias depth. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetPositionEnvelopeBiasInvert ( const bool bInBiasInvert
)

 Set Position envelope bias inversion. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetPositionEnvelopeDecayTime ( const float InDecayTimeMsec
)

 Set Position envelope decay time (msec) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetPositionEnvelopeDepth ( const float InDepth
)

 Set Position envelope envelope depth. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetPositionEnvelopeInvert ( const bool bInInvert
)

 Set Position envelope envelope inversion. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetPositionEnvelopeReleaseTime ( const float InReleaseTimeMsec
)

 Set Position envelope release time (msec) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetPositionEnvelopeSustainGain ( const float InSustainGain
)

 Set Position envelope sustain gain. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetPosLfoDepth ( const float InLfoDepth
)

 Set the Modulation depth of the Lfo controlling the Table Position around the current position value 0.0 = no modulation, 1.0 = current position +/- 0.5 (Lfo + Position result will clamp [0.0, 1.0]) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetPosLfoFrequency ( const float InLfoFrequency
)

 Set frequency of LFO controlling Table Position (in Hz) SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetPosLfoType ( const ESynthLFOType InLfoType
)

 Set the shape of the Lfo controlling the position. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetSustainPedalState ( bool InSustainPedalState
)

 Inform the synth if the sustain pedal is pressed or not. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"

void SetSynthPreset ( UMonoWaveTableSynthPreset* SynthPreset
)

 Switch to another preset (STOPS SYNTH FROM PLAYING) SynthComponents/SynthComponentMonoWaveTable.h  

void SetWaveTablePosition ( float InPosition
)

 Sets the wavetable position. Expects a percentage between 0.0 and 1.0. SynthComponents/SynthComponentMonoWaveTable.h
  • BlueprintCallable
  • Category="Synth|Components|Audio"
  • Meta=(ClampMin="0.0", ClampMax="1.0")

Protected

Name Remarks Include Path Unreal Specifiers

void InitSynth ()

 Initializes the underlying synthesizer. SynthComponents/SynthComponentMonoWaveTable.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& Eevnt
)

 Override on Post property change thing here (see if we got a new preset) SynthComponents/SynthComponentMonoWaveTable.h  

void ReactToAssetChange ( const AssetChangeInfo& ChangeInfo
)

 Callback for the UAsset this synth component is subscribed to Compares cached data to current UAsset data and makes updates SynthComponents/SynthComponentMonoWaveTable.h  

void ResetCurve ( int32 Index
)

 Helper function that resets a curve to a default saw-tooth (so a curve is always immediately audible without user effort) SynthComponents/SynthComponentMonoWaveTable.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page