Plush

ModulationChain#

plupy · Type index

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

Envelopes every note of a Sound plays through (assign with sound.props["sound.modulation"] = chain). Modulators are AHDSR envelopes on "volume", "pitch" (amount in cents) or "panning" (amount -1..1).

class ModulationChain(DataBlock)

Inherits DataBlock: its members are documented there.

Usage and examples

Members: modulators · add · set · remove

modulators#

modulators   # read-only

Each modulator as a dict: id, kind, target, attackMs, holdMs, decayMs, sustain, releaseMs, amount.

add#

add(kind='ahdsr', *, target='volume', **values)

Add an envelope (attack_ms, hold_ms, decay_ms, sustain 0..1, release_ms, amount); returns its id.

set#

set(modulator, name, value)

Change one setting (attack_ms, …) of a modulator by id.

remove#

remove(modulator)

Remove a modulator by id.

DataBlock · Sound

Source#