Plush

EffectChain#

plupy · Type index

Module: plupy · obtained from plupy.data.effect_chains[...], .new(name)

Audio effects every note of a Sound plays through, in order (assign with sound.props["sound.effects"] = chain). Kinds: "filter" (mode "LowPass", "BandPass" or "HighPass", cutoff_hz, resonance 0..1, drive_db), "gainer" (volume_db, panning -1..1), and the time-based ones that run on tracks, sequences and mix buses only: "delay" (left_ms, right_ms, feedback 0..0.95, ping_pong, damp_hz, wet_db, dry_db) and "reverb" (room_size, damping, width 0..1, pre_delay_ms, wet_db, dry_db; -96 dry for the Environment bus); every effect also has bypassed.

class EffectChain(DataBlock)

Inherits DataBlock: its members are documented there.

Usage and examples

Members: effects · add · set · move · remove

effects#

effects   # read-only

Each effect as a dict, in the order sound flows through them: id, kind and its settings.

add#

add(kind, **values)

Append an effect with optional settings (cutoff_hz=800, …); returns its id.

set#

set(effect, name, value)

Change one setting (cutoff_hz, …) of an effect by id.

move#

move(effect, index)

Move an effect to a position in the chain (0 hears the sound first).

remove#

remove(effect)

Remove an effect by id.

DataBlock · Sound

Source#