Namespace: effect

syngen.audio.effect

Provides factories that create circuits for effects processing. Importantly, these are not the only way to create effects for use with syngen. Implementations can build their own effects or use any external library that supports connecting to its audio graph.

Source:

Methods

(static) createDubDelay(optionsopt) → {syngen.audio.synth~Plugin}

Creates a feedback delay line with a filter inserted into its feedback loop.

Parameters:
Name Type Attributes Default Description
options Object <optional>
 {}
Properties
Name Type Attributes Default Description
delay Number <optional>
 0.5
dry Number <optional>
 1
feedback Number <optional>
 0.5
filterDetune Number <optional>
 0
filterFrequency Number <optional>
 syngen.const.maxFrequency
filterGain Number <optional>
 0
filterQ Number <optional>
 1
filterType String <optional>
 lowpass
maxDelayTime Number <optional>
 1
wet Number <optional>
 0.5
Source:
Returns:
Type
syngen.audio.synth~Plugin

(static) createFeedbackDelay(optionsopt) → {syngen.audio.synth~Plugin}

Creates a feedback delay line.

Parameters:
Name Type Attributes Default Description
options Object <optional>
 {}
Properties
Name Type Attributes Default Description
delay Number <optional>
 0.5
dry Number <optional>
 1
feedback Number <optional>
 0.5
maxDelayTime Number <optional>
 1
wet Number <optional>
 0.5
Source:
Returns:
Type
syngen.audio.synth~Plugin

(static) createMultitapFeedbackDelay(optionsopt) → {syngen.audio.synth~Plugin}

Creates a feedback delay line with multiple taps.

Parameters:
Name Type Attributes Default Description
options Object <optional>
 {}
Properties
Name Type Attributes Default Description
dry Number <optional>
 1
tap Array.<Object> <optional>
 []
Properties
Name Type Default Description
delay Array.<Object> 0.5}
feedback Array.<Object> 0.5}
gain Array.<Object> 1}
maxDelayTime Array.<Object> 1}
wet Number <optional>
 1
Source:
Returns:
Type
syngen.audio.synth~Plugin

(static) createPhaser(optionsopt) → {syngen.audio.synth~Plugin}

Creates a phaser or flange effect. Beware that this is not an out-of-the-box solution. Parameter values must be carefully chosen to achieve the desired effect.

Parameters:
Name Type Attributes Default Description
options Object <optional>
 {}
Properties
Name Type Attributes Default Description
dry Number <optional>
 0.5
depth Number <optional>
 0.001
delay Number <optional>
 0.01
feedback Number <optional>
 syngen.const.zeroGain
rate Number <optional>
 1
type String <optional>
 sine
wet Number <optional>
 0.5
when Number <optional>
 syngen.audio.time()
Source:
Returns:
Type
syngen.audio.synth~Plugin

(static) createPingPongDelay(optionsopt) → {syngen.audio.synth~Plugin}

Creates a feedback delay line that bounces between stereo channels.

Parameters:
Name Type Attributes Default Description
options Object <optional>
 {}
Properties
Name Type Attributes Default Description
delay Number <optional>
 0.5
dry Number <optional>
 1
feedback Number <optional>
 0.5
maxDelayTime Number <optional>
 1
wet Number <optional>
 0.5
Source:
Returns:
Type
syngen.audio.synth~Plugin

(static) createShaper(optionsopt) → {syngen.audio.synth~Plugin}

Creates a distortion effect with a configurable curve.

Parameters:
Name Type Attributes Default Description
options Object <optional>
 {}
Properties
Name Type Attributes Default Description
curve Float32Array <optional>
 syngen.audio.shape.warm()
dry Number <optional>
 1
preGain Number <optional>
 1
wet Number <optional>
 1
Source:
See:
Returns:
Type
syngen.audio.synth~Plugin

(static) createTalkbox(optionsopt) → {syngen.audio.synth~Plugin}

Creates a talk box that seamlessly blends between two formants with its mix parameter.

Parameters:
Name Type Attributes Default Description
options Object <optional>
 {}
Properties
Name Type Attributes Default Description
dry Number <optional>
 0
format0 syngen.audio.formant~Plugin <optional>
 syngen.audio.formant.createU()
format1 syngen.audio.formant~Plugin <optional>
 syngen.audio.formant.createA()
mix Number <optional>
 0.5
wet Number <optional>
 1
Source:
Returns:
Type
syngen.audio.synth~Plugin