Audio

Audio

Windows
MacOS
Linux
On this page

Actions

Create Patch

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

Target is Modular Synth Component

Get Current Playback Progress Percent

Get Current Playback Progress Percent

Target is Synth Sample Player

Get Current Playback Progress Time

Get Current Playback Progress Time

Target is Synth Sample Player

Get Current Playhead Time

Get Current Playhead Time

Target is Granular Synth

Get Curve Tangent

Get the curve interpolation type (What the curve is doing between keyframes)

Target is Synth Component Mono Wave Table

Get Key Frame Values for Table

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

Target is Synth Component Mono Wave Table

Get Max Table Index

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

Target is Synth Component Mono Wave Table

Get Num Table Entries

Start BP functionality // Get the number of table elements from Blueprint

Target is Synth Component Mono Wave Table

Get Sample Duration

Get Sample Duration

Target is Granular Synth

Is Loaded

Is Loaded

Target is Synth Sample Player

Is Playing

Returns true if this component is currently playing.

Target is Synth Component

Note Off

Stop the note (will only do anything if a voice is playing with that note)

Target is Modular Synth Component

Note On

Note On

Target is Granular Synth

On Sample Loaded

On Sample Loaded

On Sample Playback Progress

On Sample Playback Progress

Refresh All Wave Tables

Refresh all wavetables (from Game Thread data)

Target is Synth Component Mono Wave Table

Refresh Wave Table

Refresh a particular wavetable (from Game Thread data)

Target is Synth Component Mono Wave Table

Seek to Time

Seek to Time

Target is Synth Sample Player

Set Amp Envelope Attack Time

Set Amp envelope attack time (msec)

Target is Synth Component Mono Wave Table

Set Amp Envelope Bias Depth

Set the bias depth of the the Amp envelope

Target is Synth Component Mono Wave Table

Set Amp Envelope Bias Invert

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

Target is Synth Component Mono Wave Table

Set Amp Envelope Decay Time

Set Amp envelope decay time (msec)

Target is Synth Component Mono Wave Table

Set Amp Envelope Depth

Set the overall depth of the Amp envelope

Target is Synth Component Mono Wave Table

Set Amp Envelope Invert

Set whether or not the Amp envelope is inverted

Target is Synth Component Mono Wave Table

Set Amp Envelope Release Time

Set Amp envelope release time (msec)

Target is Synth Component Mono Wave Table

Set Amp Envelope Sustain Gain

Set Amp envelope sustain gain [0.0, 1.0]

Target is Synth Component Mono Wave Table

Set Attack Time

Sets the envelope attack time in msec.

Target is Modular Synth Component

Set Chorus Depth

Sets the chorus depth

Target is Modular Synth Component

Set Chorus Enabled

Sets whether or not chorus is enabled.

Target is Modular Synth Component

Set Chorus Feedback

Sets the chorus feedback

Target is Modular Synth Component

Set Chorus Frequency

Sets the chorus frequency

Target is Modular Synth Component

Set Curve Interpolation Type

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)

Target is Synth Component Mono Wave Table

Set Curve Tangent

Set the curve tangent ("Curve depth" between keyframes) This should only be used for live-editing features! (changing the curves at runtime is expensive)

Target is Synth Component Mono Wave Table

Set Curve Value

Set a Keyframe value given a Table number and Keyframe number. Returns false if the request was invalid. NewValue will be clamped from +/- 1.0

Target is Synth Component Mono Wave Table

Set Decay Time

Sets the envelope decay time in msec.

Target is Modular Synth Component

Set Enable Legato

Sets whether or not to use legato for the synthesizer.

Target is Modular Synth Component

Set Enable Patch

Set Enable Patch

Target is Modular Synth Component

Set Enable Polyphony

Sets whether or not to use polyphony for the synthesizer.

Target is Modular Synth Component

Set Enable Retrigger

Sets whether or not to retrigger envelope per note on.

Target is Modular Synth Component

Set Enable Unison

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

Target is Modular Synth Component

Set Filter Algorithm

Sets the filter algorithm.

Target is Modular Synth Component

Set Filter Envelope Attack Time

Set Low-Pass Filter envelope attack time (msec)

Target is Synth Component Mono Wave Table

Set Filter Envelope Bias Depth

Set Low-Pass Filter envelope bias depth

Target is Synth Component Mono Wave Table

Set Filter Envelope Bias Invert

Set Low-Pass Filter envelope bias inversion

Target is Synth Component Mono Wave Table

Set Filter Envelope Depth

Set Low-Pass Filter envelope depth

Target is Synth Component Mono Wave Table

Set Filter Envelope Invert

Set Low-Pass Filter envelope inversion

Target is Synth Component Mono Wave Table

Set Filter Envelope Release Time

Set Low-Pass Filter envelope release time (msec)

Target is Synth Component Mono Wave Table

Set Filter Envelope Sustain Gain

Set Low-Pass Filter envelope sustain gain

Target is Synth Component Mono Wave Table

Set Filter Envelopen Decay Time

Set Low-Pass Filter envelope decay time (msec)

Target is Synth Component Mono Wave Table

Set Filter Frequency

Sets the filter cutoff frequency in hz.

Target is Modular Synth Component

Set Filter Frequency Mod

Sets the filter cutoff frequency in hz.

Target is Modular Synth Component

Set Filter Q

Sets the filter Q (resonance)

Target is Modular Synth Component

Set Filter QMod

Sets a modulated filter Q (resonance)

Target is Modular Synth Component

Set Filter Type

Sets the filter type.

Target is Modular Synth Component

Set Frequency

Sets the oscillator's frequency

Target is Synth Component Mono Wave Table

Set Frequency Pitch Bend

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

Target is Synth Component Mono Wave Table

Set Frequency with Midi Note

Set the oscillator's frequency via midi note number

Target is Synth Component Mono Wave Table

Set Gain Db

Sets the synth gain in decibels.

Target is Modular Synth Component

Set Grain Duration

Set Grain Duration

Target is Granular Synth

Set Grain Envelope Type

Set Grain Envelope Type

Target is Granular Synth

Set Grain Pan

Set Grain Pan

Target is Granular Synth

Set Grain Pitch

Set Grain Pitch

Target is Granular Synth

Set Grain Probability

Set Grain Probability

Target is Granular Synth

Set Grain Volume

Set Grain Volume

Target is Granular Synth

Set Grains Per Second

Set Grains Per Second

Target is Granular Synth

Set LFOFrequency

Sets the LFO frequency in hz

Target is Modular Synth Component

Set LFOFrequency Mod

Sets the LFO frequency modulation in hz

Target is Modular Synth Component

Set LFOGain

Sets the LFO gain factor

Target is Modular Synth Component

Set LFOGain Mod

Sets the LFO gain mod factor (external modulation)

Target is Modular Synth Component

Set LFOMode

Sets the LFO type

Target is Modular Synth Component

Set LFOPatch

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

Target is Modular Synth Component

Set LFOType

Sets the LFO type

Target is Modular Synth Component

Set Low Pass Filter Resonance

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

Target is Synth Component Mono Wave Table

Set Mod Env Attack Time

Sets the envelope modulator attack time in msec

Target is Modular Synth Component

Set Mod Env Bias Invert

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

Target is Modular Synth Component

Set Mod Env Bias Patch

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

Target is Modular Synth Component

Set Mod Env Decay Time

Sets the envelope modulator attack time in msec

Target is Modular Synth Component

Set Mod Env Depth

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

Target is Modular Synth Component

Set Mod Env Invert

Sets whether or not to invert the envelope modulator.

Target is Modular Synth Component

Set Mod Env Patch

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

Target is Modular Synth Component

Set Mod Env Release Time

Sets the envelope modulator release

Target is Modular Synth Component

Set Mod Env Sustain Gain

Sets the envelope modulator sustain gain

Target is Modular Synth Component

Set Osc Cents

Sets the oscillator cents.

Target is Modular Synth Component

Set Osc Frequency Mod

Set the oscillator frequency modulation

Target is Modular Synth Component

Set Osc Gain

Set the oscillator gain.

Target is Modular Synth Component

Set Osc Gain Mod

Set the oscillator gain modulation.

Target is Modular Synth Component

Set Osc Octave

Sets the oscillator octaves

Target is Modular Synth Component

Set Osc Pulsewidth

Sets the square wave pulsewidth [0.0, 1.0]

Target is Modular Synth Component

Set Osc Semitones

Sets the oscillator semitones.

Target is Modular Synth Component

Set Osc Sync

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

Target is Modular Synth Component

Set Osc Type

Set the oscillator type.

Target is Modular Synth Component

Set Pan

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

Target is Modular Synth Component

Set Pitch

Set Pitch

Target is Synth Sample Player

Set Pitch Bend

Sets the synth pitch bend amount.

Target is Modular Synth Component

Set Playback Speed

Set Playback Speed

Target is Granular Synth

Set Playhead Time

Set Playhead Time

Target is Granular Synth

Set Portamento

Sets the synth portamento [0.0, 1.0]

Target is Modular Synth Component

Set Pos Lfo Depth

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

Target is Synth Component Mono Wave Table

Set Pos Lfo Frequency

Set frequency of LFO controlling Table Position (in Hz)

Target is Synth Component Mono Wave Table

Set Pos Lfo Type

Set the shape of the Lfo controlling the position

Target is Synth Component Mono Wave Table

Set Position Envelope Attack Time

Set Position envelope attack time (msec)

Target is Synth Component Mono Wave Table

Set Position Envelope Bias Depth

Set Position envelope bias depth

Target is Synth Component Mono Wave Table

Set Position Envelope Bias Invert

Set Position envelope bias inversion

Target is Synth Component Mono Wave Table

Set Position Envelope Decay Time

Set Position envelope decay time (msec)

Target is Synth Component Mono Wave Table

Set Position Envelope Depth

Set Position envelope envelope depth

Target is Synth Component Mono Wave Table

Set Position Envelope Invert

Set Position envelope envelope inversion

Target is Synth Component Mono Wave Table

Set Position Envelope Release Time

Set Position envelope release time (msec)

Target is Synth Component Mono Wave Table

Set Position Envelope Sustain Gain

Set Position envelope sustain gain

Target is Synth Component Mono Wave Table

Set Release Time

Sets the envelope release time in msec.

Target is Modular Synth Component

Set Release Time Msec

Set Release Time Msec

Target is Granular Synth

Set Scrub Mode

Set Scrub Mode

Target is Granular Synth

Set Scrub Time Width

Set Scrub Time Width

Target is Synth Sample Player

Set Sound Wave

This will override the current sound wave if one is set, stop audio, and reload the new sound wave

Target is Synth Sample Player

Set Spread

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

Target is Modular Synth Component

Set Stereo Delay Feedback

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

Target is Modular Synth Component

Set Stereo Delay Is Enabled

Sets whether not stereo delay is enabled.

Target is Modular Synth Component

Set Stereo Delay Mode

Sets whether not stereo delay is enabled.

Target is Modular Synth Component

Set Stereo Delay Ratio

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

Target is Modular Synth Component

Set Stereo Delay Time

Sets the amount of stereo delay time in msec.

Target is Modular Synth Component

Set Stereo Delay Wetlevel

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

Target is Modular Synth Component

Set Sustain Gain

Sets the envelope sustain gain value.

Target is Modular Synth Component

Set Sustain Pedal State

Inform the synth if the sustain pedal is pressed or not

Target is Synth Component Mono Wave Table

Set Synth Preset

Sets the preset struct for the synth

Target is Modular Synth Component

Set Wave Table Position

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

Target is Synth Component Mono Wave Table

Start

Starts the synth generating audio.

Target is Synth Component

Stop

Stops the synth generating audio.

Target is Synth Component

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss