envelopes¶

class Done(calculation_rate=None, source=None, **kwargs)¶

Bases: UGen

Triggers when source sets its done flag.

>>> source = supriya.ugens.Line.kr()
>>> done = supriya.ugens.Done.kr(
...     source=source,
... )
>>> done
Done.kr()

classmethod kr(source: SupportsFloat | UGenMethodMixin | None = None) → Done¶

property source : SupportsFloat | UGenMethodMixin¶

class EnvGen(calculation_rate=None, gate=1.0, level_scale=1.0, level_bias=0.0, time_scale=1.0, done_action=0.0, envelope=None, **kwargs)¶

Bases: UGen

An envelope generator.

>>> envelope = supriya.synthdefs.Envelope.percussive()
>>> supriya.ugens.EnvGen.ar(envelope=envelope)
EnvGen.ar()

classmethod ar(gate: SupportsFloat | UGenMethodMixin = 1.0, level_scale: SupportsFloat | UGenMethodMixin = 1.0, level_bias: SupportsFloat | UGenMethodMixin = 0.0, time_scale: SupportsFloat | UGenMethodMixin = 1.0, done_action: SupportsFloat | UGenMethodMixin = 0.0, envelope: SupportsFloat | UGenMethodMixin | None = None) → EnvGen¶

classmethod kr(gate: SupportsFloat | UGenMethodMixin = 1.0, level_scale: SupportsFloat | UGenMethodMixin = 1.0, level_bias: SupportsFloat | UGenMethodMixin = 0.0, time_scale: SupportsFloat | UGenMethodMixin = 1.0, done_action: SupportsFloat | UGenMethodMixin = 0.0, envelope: SupportsFloat | UGenMethodMixin | None = None) → EnvGen¶

property done_action : SupportsFloat | UGenMethodMixin¶

property envelope : SupportsFloat | UGenMethodMixin¶

property gate : SupportsFloat | UGenMethodMixin¶

property level_bias : SupportsFloat | UGenMethodMixin¶

property level_scale : SupportsFloat | UGenMethodMixin¶

property time_scale : SupportsFloat | UGenMethodMixin¶

class Free(calculation_rate=None, trigger=0, node_id=None, **kwargs)¶

Bases: UGen

Frees the node at node_id when triggered by trigger.

>>> node_id = 1000
>>> trigger = supriya.ugens.Impulse.kr(frequency=1.0)
>>> free = supriya.ugens.Free.kr(
...     node_id=node_id,
...     trigger=trigger,
... )
>>> free
Free.kr()

classmethod kr(trigger: SupportsFloat | UGenMethodMixin = 0, node_id: SupportsFloat | UGenMethodMixin | None = None) → Free¶

property node_id : SupportsFloat | UGenMethodMixin¶

property trigger : SupportsFloat | UGenMethodMixin¶

class FreeSelf(calculation_rate=None, trigger=None, **kwargs)¶

Bases: UGen

Frees the enclosing synth when triggered by trigger.

>>> trigger = supriya.ugens.Impulse.kr(frequency=1.0)
>>> free_self = supriya.ugens.FreeSelf.kr(
...     trigger=trigger,
... )
>>> free_self
FreeSelf.kr()

classmethod kr(trigger: SupportsFloat | UGenMethodMixin | None = None) → FreeSelf¶

property trigger : SupportsFloat | UGenMethodMixin¶

class FreeSelfWhenDone(calculation_rate=None, source=None)¶

Bases: UGen

Frees the enclosing synth when source sets its done flag.

>>> source = supriya.ugens.Line.kr()
>>> free_self_when_done = supriya.ugens.FreeSelfWhenDone.kr(
...     source=source,
... )
>>> free_self_when_done
FreeSelfWhenDone.kr()

classmethod kr(source: SupportsFloat | UGenMethodMixin | None = None) → FreeSelfWhenDone¶

property source : SupportsFloat | UGenMethodMixin¶

class Linen(calculation_rate=None, gate=1.0, attack_time=0.01, sustain_level=1.0, release_time=1.0, done_action=0, **kwargs)¶

Bases: UGen

A simple line generating unit generator.

>>> supriya.ugens.Linen.kr()
Linen.kr()

classmethod kr(gate: SupportsFloat | UGenMethodMixin = 1.0, attack_time: SupportsFloat | UGenMethodMixin = 0.01, sustain_level: SupportsFloat | UGenMethodMixin = 1.0, release_time: SupportsFloat | UGenMethodMixin = 1.0, done_action: SupportsFloat | UGenMethodMixin = 0) → Linen¶

property attack_time : SupportsFloat | UGenMethodMixin¶

property done_action : SupportsFloat | UGenMethodMixin¶

property gate : SupportsFloat | UGenMethodMixin¶

property release_time : SupportsFloat | UGenMethodMixin¶

property sustain_level : SupportsFloat | UGenMethodMixin¶

class Pause(calculation_rate=None, trigger=None, node_id=None, **kwargs)¶

Bases: UGen

Pauses the node at node_id when triggered by trigger.

>>> node_id = 1000
>>> trigger = supriya.ugens.Impulse.kr(frequency=1.0)
>>> pause = supriya.ugens.Pause.kr(
...     node_id=node_id,
...     trigger=trigger,
... )
>>> pause
Pause.kr()

classmethod kr(trigger: SupportsFloat | UGenMethodMixin | None = None, node_id: SupportsFloat | UGenMethodMixin | None = None) → Pause¶

property node_id : SupportsFloat | UGenMethodMixin¶

property trigger : SupportsFloat | UGenMethodMixin¶

class PauseSelf(calculation_rate=None, trigger=None, **kwargs)¶

Bases: UGen

Pauses the enclosing synth when triggered by trigger.

>>> trigger = supriya.ugens.Impulse.kr(frequency=1.0)
>>> pause_self = supriya.ugens.PauseSelf.kr(
...     trigger=trigger,
... )
>>> pause_self
PauseSelf.kr()

classmethod kr(trigger: SupportsFloat | UGenMethodMixin | None = None) → PauseSelf¶

property trigger : SupportsFloat | UGenMethodMixin¶

class PauseSelfWhenDone(calculation_rate=None, source=None)¶

Bases: UGen

Pauses the enclosing synth when source sets its done flag.

>>> source = supriya.ugens.Line.kr()
>>> pause_self_when_done = supriya.ugens.PauseSelfWhenDone.kr(
...     source=source,
... )
>>> pause_self_when_done
PauseSelfWhenDone.kr()

classmethod kr(source: SupportsFloat | UGenMethodMixin | None = None) → PauseSelfWhenDone¶

property source : SupportsFloat | UGenMethodMixin¶