USynthComponentMonoWaveTable

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Synthesis

Header

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

Include

#include "SynthComponents/SynthComponentMonoWaveTable.h"

Syntax

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

Variables

Name Description

Protected variable

UMonoWaveTableS...

 

CachedPreset

Protected variable UProperty Category, EditAnywhere

UMonoWaveTableS...

 

CurrentPreset

The settings asset to use for this synth

Public variable UProperty Category BlueprintAssignable

FNumTablesChang...

 

OnNumTablesChanged

Curve array altered.

Public variable UProperty Category BlueprintAssignable

FOnTableAltered

 

OnTableAltered

Wave Table curve was edited.

Protected variable

Audio::DefaultW...

 

SampleRate

Protected variable

Audio::FMonoWav...

 

Synth

Underlying wavetable synth

Constructors

No constructors are accessible with public or protected access.

Destructors

No destructors are accessible with public or protected access.

Functions

Name Description

Public function UFunction BlueprintCallable, Category

float

 

GetCurveTangent

(
    int32 TableIndex
)

TODO: Enable this functionality when Curve bug is fixed.

Public function Const UFunction BlueprintCallable, Category

TArray< floa...

 

GetKeyFrameValuesForTable

(
    float TableIndex
)

Get an array of floats that represent the key frames in the requested curve.

Public function Const UFunction BlueprintCallable, Category

int32

 

GetMaxTableIndex()

Get the number of curves in the wave table. (returns -1 if there is no asset)

Public function UFunction BlueprintCallable, Category

int32

 

GetNumTableEntries()

Get the number of table elements from Blueprint.

Protected function

void

 

InitSynth()

Initializes the underlying synthesizer.

Public function UFunction BlueprintCallable, Category

void

 

NoteOff

(
    const float InMidiNote
)

Starts a new note (retrigs modulators, etc.)

Public function UFunction BlueprintCallable, Category

void

 

NoteOn

(
    const float InMidiNote,
    const float InVelocity
)

Starts a new note (retrigs modulators, etc.)

Protected function

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

Public function UFunction BlueprintCallable, Category

void

 

RefreshAllWaveTables()

Refresh all wavetables (from Game Thread data)

Public function UFunction BlueprintCallable, Category

void

 

RefreshWaveTable

(
    int32 Index
)

Refresh a particular wavetable (from Game Thread data)

Protected function

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)

Public function UFunction BlueprintCallable, Category

void

 

SetAmpEnvelopeAttackTime

(
    const float InAttackTimeMsec
)

Set Amp envelope attack time (msec)

Public function UFunction BlueprintCallable, Category

void

 

SetAmpEnvelopeBiasDepth

(
    const float InDepth
)

Set the bias depth of the the Amp envelope.

Public function UFunction BlueprintCallable, Category

void

 

SetAmpEnvelopeBiasInvert

(
    const bool bInBiasInvert
)

Set whether or not the Amp envelope's bias is inverted.

Public function UFunction BlueprintCallable, Category

void

 

SetAmpEnvelopeDecayTime

(
    const float InDecayTimeMsec
)

Set Amp envelope decay time (msec)

Public function UFunction BlueprintCallable, Category

void

 

SetAmpEnvelopeDepth

(
    const float InDepth
)

Set the overall depth of the Amp envelope.

Public function UFunction BlueprintCallable, Category

void

 

SetAmpEnvelopeInvert

(
    const bool bInInvert
)

Set whether or not the Amp envelope is inverted.

Public function UFunction BlueprintCallable, Category

void

 

SetAmpEnvelopeReleaseTime

(
    const float InReleaseTimeMsec
)

Set Amp envelope release time (msec)

Public function UFunction BlueprintCallable, Category

void

 

SetAmpEnvelopeSustainGain

(
    const float InSustainGain
)

Set Amp envelope sustain gain [0.0, 1.0].

Public function UFunction BlueprintCallable, Category

bool

 

SetCurveInterpolationType

(
    CurveInterpolationType Interpolatio...,
    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)

Public function UFunction BlueprintCallable, Category

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)

Public function UFunction BlueprintCallable, Category

bool

 

SetCurveValue

(
    int32 TableIndex,
    int32 KeyframeIndex,
    const float NewValue
)

Set a Keyframe value given a Table number and Keyframe number.

Public function UFunction BlueprintCallable, Category

void

 

SetFilterEnvelopeAttackTime

(
    const float InAttackTimeMsec
)

Set Low-Pass Filter envelope attack time (msec)

Public function UFunction BlueprintCallable, Category

void

 

SetFilterEnvelopeBiasDepth

(
    const float InDepth
)

Set Low-Pass Filter envelope bias depth.

Public function UFunction BlueprintCallable, Category

void

 

SetFilterEnvelopeBiasInvert

(
    const bool bInBiasInvert
)

Set Low-Pass Filter envelope bias inversion.

Public function UFunction BlueprintCallable, Category

void

 

SetFilterEnvelopeDepth

(
    const float InDepth
)

Set Low-Pass Filter envelope depth.

Public function UFunction BlueprintCallable, Category

void

 

SetFilterEnvelopeInvert

(
    const bool bInInvert
)

Set Low-Pass Filter envelope inversion.

Public function UFunction BlueprintCallable, Category

void

 

SetFilterEnvelopenDecayTime

(
    const float InDecayTimeMsec
)

Set Low-Pass Filter envelope decay time (msec)

Public function UFunction BlueprintCallable, Category

void

 

SetFilterEnvelopeReleaseTime

(
    const float InReleaseTimeMsec
)

Set Low-Pass Filter envelope release time (msec)

Public function UFunction BlueprintCallable, Category

void

 

SetFilterEnvelopeSustainGain

(
    const float InSustainGain
)

Set Low-Pass Filter envelope sustain gain.

Public function UFunction BlueprintCallable, Category

void

 

SetFrequency

(
    const float FrequencyHz
)

Sets the oscillator's frequency.

Public function UFunction BlueprintCallable, Category

void

 

SetFrequencyPitchBend

(
    const float FrequencyOffsetCents
)

Set a frequency offset in cents (for pitch modulation such as the Pitch Bend Wheel)

Public function UFunction BlueprintCallable, Category

void

 

SetFrequencyWithMidiNote

(
    const float InMidiNote
)

Set the oscillator's frequency via midi note number.

Public function UFunction BlueprintCallable, Category

void

 

SetLowPassFilterFrequency

(
    float InNewFrequency
)

Set the Cut-off frequency of the low-pass filter.

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetLowPassFilterResonance

(
    float InNewQ
)

Set the Cut-off frequency of the low-pass filter.

Public function UFunction BlueprintCallable, Category

void

 

SetPositionEnvelopeAttackTime

(
    const float InAttackTimeMsec
)

Set Position envelope attack time (msec)

Public function UFunction BlueprintCallable, Category

void

 

SetPositionEnvelopeBiasDepth

(
    const float InDepth
)

Set Position envelope bias depth.

Public function UFunction BlueprintCallable, Category

void

 

SetPositionEnvelopeBiasInvert

(
    const bool bInBiasInvert
)

Set Position envelope bias inversion.

Public function UFunction BlueprintCallable, Category

void

 

SetPositionEnvelopeDecayTime

(
    const float InDecayTimeMsec
)

Set Position envelope decay time (msec)

Public function UFunction BlueprintCallable, Category

void

 

SetPositionEnvelopeDepth

(
    const float InDepth
)

Set Position envelope envelope depth.

Public function UFunction BlueprintCallable, Category

void

 

SetPositionEnvelopeInvert

(
    const bool bInInvert
)

Set Position envelope envelope inversion.

Public function UFunction BlueprintCallable, Category

void

 

SetPositionEnvelopeReleaseTime

(
    const float InReleaseTimeMsec
)

Set Position envelope release time (msec)

Public function UFunction BlueprintCallable, Category

void

 

SetPositionEnvelopeSustainGain

(
    const float InSustainGain
)

Set Position envelope sustain gain.

Public function UFunction BlueprintCallable, Category

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

Public function UFunction BlueprintCallable, Category

void

 

SetPosLfoFrequency

(
    const float InLfoFrequency
)

Set frequency of LFO controlling Table Position (in Hz)

Public function UFunction BlueprintCallable, Category

void

 

SetPosLfoType

(
    const ESynthLFOType InLfoType
)

Set the shape of the Lfo controlling the position.

Public function UFunction BlueprintCallable, Category

void

 

SetSustainPedalState

(
    bool InSustainPedalState
)

Inform the synth if the sustain pedal is pressed or not.

Public function

void

 

SetSynthPreset

(
    UMonoWaveTableSynthPreset* Syn...
)

Switch to another preset (STOPS SYNTH FROM PLAYING)

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetWaveTablePosition

(
    float InPosition
)

Sets the wavetable position. Expects a percentage between 0.0 and 1.0.

Overridden from UObject

Name Description

Protected function Virtual

void

 

PostEditChangeChainProperty

(
    FPropertyChangedChainEvent& Eevnt
)

Override on Post property change thing here (see if we got a new preset)

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