FoxDot.lib.Effects.Util

Filter Effects

Effects are added to Player objects as keywords instructions like dur or amp but are a little more tricky. Each effect has a “title” keyword, which requires a nonzero value to add the effect to a Player. Effects also have other attribute keywords which can be any value and may have a default value which is set when a Player is created.

::

# Example. Reverb effect “title” is room and attribute is mix, which # defaults to 0.25. The following adds a reverb effect

p1 >> pads(room=0.5)

# This still adds the effect, but a mix of 0 doesn’t actually do anything

p1 >> pads(room=0.5, mix=0)

# This effect is not added as the “title” keyword, room, is 0

p1 >> pads(room=0, mix=0.5)

Other effects are outlined below:

High Pass Filter - Title keyword: hpf, Attribute keyword(s): hpr Only frequences above the value of hpf are kept in the final signal. Use hpr to set the resonance (usually a value between 0 and 1)

Low Pass Filter - Title keyword: lpf, Attribute keyword(s): lpr Only frequences below the value of lpf are kept in final signal. Use lpr to set the resonance (usually a value between 0 and 1)

Bitcrush - Title keyword: bits, Attribute keyword(s): crush The bit depth, in number of bits, that the signal is reduced to; this is a value between 1 and 24 where other values are ignored. Use crush to set the amount of reduction to the bitrate (defaults to 8)

Reverb - Title keyword: room, Attribute keyword(s): mix The room argument specifies the size of the room and mix is the dry/wet mix of reverb; this should be a value between 0 and 1 (defalts to 0.25)

Chop - Title keyword: chop, Attribute keyword(s): sus ‘Chops’ the signal into chunks using a low frequency pulse wave over the sustain of a note.

Slide To - Title keyword: slide, Attribute keyword(s): Slides’ the frequency value of a signal to freq * (slide+1) over the duration of a note (defaults to 0)

Slide From - Title keyword: slidefrom, Attribute keyword(s): Slides’ the frequency value of a signal from freq * (slidefrom) over the duration of a note (defaults to 1)

Comb delay (echo) - Title keyword: echo, Attribute keyword(s): decay Sets the decay time for any echo effect in beats, works best on Sample Player (defaults to 0)

Panning - Title keyword: pan, Attribute keyword(s): Panning, where -1 is far left, 1 is far right (defaults to 0)

Vibrato - Title keyword: vib, Attribute keyword(s): Vibrato (defaults to 0)

Undocumented: Spin, Shape, Formant, BandPassFilter, Echo

class FoxDot.lib.Effects.Util.Effect(foxdot_name, synthdef, args={}, control=False)

Bases: object

add(string)

add_var(name)

doc(string)

Set a docstring for the effects

list_effects()

load()

Load the Effect

save()

writes to file and sends to server

server = FoxDot ServerManager Instance -> localhost:57110

classmethod set_server(server)

class FoxDot.lib.Effects.Util.EffectManager

Bases: dict

all_kwargs()

Returns all keywords for all effects

kwargs()

Returns the title keywords for each effect

new(foxdot_arg_name, synthdef, args, order=2)

reload()

Re-sends each effect to SC

sort_by(attr)

Returns the keys sorted by attribute name

values()

Return an object providing a view on the dict’s values.

class FoxDot.lib.Effects.Util.In

Bases: Effect

class FoxDot.lib.Effects.Util.Out

Bases: Effect