triggers

class Clip(*, calculation_rate: CalculationRate | SupportsInt | str | None, source: SupportsFloat | UGenScalar, minimum: SupportsFloat | UGenScalar = 0.0, maximum: SupportsFloat | UGenScalar = 1.0, **kwargs)

Bases: UGen

Clips a signal outside given thresholds.

>>> source = supriya.ugens.SinOsc.ar()
>>> clip = supriya.ugens.Clip.ar(
...     maximum=0.9,
...     minimum=0.1,
...     source=source,
... )
>>> clip
<Clip.ar()[0]>
classmethod ar(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], minimum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, maximum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
classmethod ir(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], minimum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, maximum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
classmethod kr(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], minimum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, maximum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
property maximum : UGenScalar
property minimum : UGenScalar
property source : UGenScalar
class Fold(*, calculation_rate: CalculationRate | SupportsInt | str | None, source: SupportsFloat | UGenScalar, minimum: SupportsFloat | UGenScalar = 0.0, maximum: SupportsFloat | UGenScalar = 1.0, **kwargs)

Bases: UGen

Folds a signal outside given thresholds.

>>> source = supriya.ugens.SinOsc.ar()
>>> fold = supriya.ugens.Fold.ar(
...     maximum=0.9,
...     minimum=0.1,
...     source=source,
... )
>>> fold
<Fold.ar()[0]>
classmethod ar(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], minimum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, maximum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
classmethod ir(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], minimum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, maximum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
classmethod kr(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], minimum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, maximum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
property maximum : UGenScalar
property minimum : UGenScalar
property source : UGenScalar
class Gate(*, calculation_rate: CalculationRate | SupportsInt | str | None, source: SupportsFloat | UGenScalar, trigger: SupportsFloat | UGenScalar = 0, **kwargs)

Bases: UGen

Gates or holds.

>>> source = supriya.ugens.WhiteNoise.ar()
>>> trigger = supriya.ugens.Dust.kr(density=1)
>>> gate = supriya.ugens.Gate.ar(
...     source=source,
...     trigger=trigger,
... )
>>> gate
<Gate.ar()[0]>
classmethod ar(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
classmethod kr(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
property source : UGenScalar
property trigger : UGenScalar
class InRange(*, calculation_rate: CalculationRate | SupportsInt | str | None, source: SupportsFloat | UGenScalar, minimum: SupportsFloat | UGenScalar = 0.0, maximum: SupportsFloat | UGenScalar = 1.0, **kwargs)

Bases: UGen

Tests if a signal is within a given range.

>>> source = supriya.ugens.SinOsc.ar()
>>> in_range = supriya.ugens.InRange.ar(
...     maximum=0.9,
...     minimum=0.1,
...     source=source,
... )
>>> in_range
<InRange.ar()[0]>
classmethod ar(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], minimum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, maximum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
classmethod ir(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], minimum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, maximum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
classmethod kr(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], minimum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, maximum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
property maximum : UGenScalar
property minimum : UGenScalar
property source : UGenScalar
class Latch(*, calculation_rate: CalculationRate | SupportsInt | str | None, source: SupportsFloat | UGenScalar, trigger: SupportsFloat | UGenScalar = 0, **kwargs)

Bases: UGen

Samples and holds.

>>> source = supriya.ugens.WhiteNoise.ar()
>>> trigger = supriya.ugens.Dust.kr(density=1)
>>> latch = supriya.ugens.Latch.ar(
...     source=source,
...     trigger=trigger,
... )
>>> latch
<Latch.ar()[0]>
classmethod ar(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
classmethod kr(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
property source : UGenScalar
property trigger : UGenScalar
class LeastChange(*, calculation_rate: CalculationRate | SupportsInt | str | None, a: SupportsFloat | UGenScalar = 0, b: SupportsFloat | UGenScalar = 0, **kwargs)

Bases: UGen

Outputs least changed input.

>>> least_change = supriya.ugens.LeastChange.ar(
...     a=0,
...     b=0,
... )
>>> least_change
<LeastChange.ar()[0]>
classmethod ar(*, a: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, b: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
classmethod kr(*, a: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, b: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
property a : UGenScalar
property b : UGenScalar
class MostChange(*, calculation_rate: CalculationRate | SupportsInt | str | None, a: SupportsFloat | UGenScalar = 0, b: SupportsFloat | UGenScalar = 0, **kwargs)

Bases: UGen

Outputs most changed input.

>>> most_change = supriya.ugens.MostChange.ar(
...     a=0,
...     b=0,
... )
>>> most_change
<MostChange.ar()[0]>
classmethod ar(*, a: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, b: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
classmethod kr(*, a: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, b: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
property a : UGenScalar
property b : UGenScalar
class Peak(*, calculation_rate: CalculationRate | SupportsInt | str | None, source: SupportsFloat | UGenScalar, trigger: SupportsFloat | UGenScalar = 0, **kwargs)

Bases: UGen

Tracks peak signal amplitude.

>>> source = supriya.ugens.In.ar(bus=0)
>>> trigger = supriya.ugens.Impulse.kr(frequency=1)
>>> peak = supriya.ugens.Peak.ar(
...     source=source,
...     trigger=trigger,
... )
>>> peak
<Peak.ar()[0]>
classmethod ar(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
classmethod kr(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
property source : UGenScalar
property trigger : UGenScalar
class PeakFollower(*, calculation_rate: CalculationRate | SupportsInt | str | None, source: SupportsFloat | UGenScalar, decay: SupportsFloat | UGenScalar = 0.999, **kwargs)

Bases: UGen

Tracks peak signal amplitude.

>>> source = supriya.ugens.In.ar(bus=0)
>>> peak_follower = supriya.ugens.PeakFollower.ar(
...     decay=0.999,
...     source=source,
... )
>>> peak_follower
<PeakFollower.ar()[0]>
classmethod ar(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], decay: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.999) → UGenOperable
classmethod kr(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], decay: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.999) → UGenOperable
property decay : UGenScalar
property source : UGenScalar
class Phasor(*, calculation_rate: CalculationRate | SupportsInt | str | None, trigger: SupportsFloat | UGenScalar = 0, rate: SupportsFloat | UGenScalar = 1.0, start: SupportsFloat | UGenScalar = 0.0, stop: SupportsFloat | UGenScalar = 1.0, reset_pos: SupportsFloat | UGenScalar = 0.0, **kwargs)

Bases: UGen

A resettable linear ramp between two levels.

>>> trigger = supriya.ugens.Impulse.kr(frequency=0.5)
>>> phasor = supriya.ugens.Phasor.ar(
...     rate=1,
...     reset_pos=0,
...     start=0,
...     stop=1,
...     trigger=trigger,
... )
>>> phasor
<Phasor.ar()[0]>
classmethod ar(*, trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, rate: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0, start: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, stop: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0, reset_pos: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0) → UGenOperable
classmethod kr(*, trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, rate: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0, start: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, stop: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0, reset_pos: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0) → UGenOperable
property rate : UGenScalar
property reset_pos : UGenScalar
property start : UGenScalar
property stop : UGenScalar
property trigger : UGenScalar
class Poll(calculation_rate=None, label=None, source=None, special_index=None, trigger=None, trigger_id=-1)

Bases: UGen

A UGen poller.

>>> sine = supriya.ugens.SinOsc.ar()
>>> trigger = supriya.ugens.Impulse.kr(frequency=1)
>>> poll = supriya.ugens.Poll.ar(
...     source=sine,
...     trigger=trigger,
...     trigger_id=1234,
... )
>>> poll
<Poll.ar()[0]>

Unlike sclang, Python does not share any inter-process communication with scsynth. This means that the Poll UGen is not able to automatically print out its diagnostic messages into a Python interpreter session.

To get information out of the Poll UGen, we first need to set the Poll’s trigger_id to a value greater than 0. This will cause the poll to send /tr OSC messages back to its client - Python. We can then register a callback to respond to these /tr messages.

>>> with supriya.SynthDefBuilder() as builder:
...     sine = supriya.ugens.SinOsc.ar()
...     trigger = supriya.ugens.Impulse.kr(frequency=1)
...     poll = supriya.ugens.Poll.ar(
...         source=sine,
...         trigger=trigger,
...         trigger_id=1234,
...     )
... 
>>> synthdef = builder.build()

>>> server = supriya.Server().boot(port=supriya.osc.find_free_port())
>>> _ = server.add_synthdefs(
...     synthdef,
...     on_completion=lambda context: context.add_synth(synthdef),
... )
>>> _ = server.sync()
>>> callback = server.osc_protocol.register(
...     pattern="/tr",
...     procedure=lambda message: print("Polled: {!r}".format(message)),
...     once=True,
... )

>>> _ = server.quit()
classmethod ar(label=None, source=None, trigger=None, trigger_id=-1)
classmethod kr(label=None, source=None, trigger=None, trigger_id=-1)
classmethod new(label=None, source=None, trigger=None, trigger_id=-1)
property label : UGenVector
property source : UGenScalar
property trigger : UGenScalar
property trigger_id : UGenScalar
class RunningMax(*, calculation_rate: CalculationRate | SupportsInt | str | None, source: SupportsFloat | UGenScalar, trigger: SupportsFloat | UGenScalar = 0, **kwargs)

Bases: UGen

Tracks maximum signal amplitude.

>>> source = supriya.ugens.In.ar(bus=0)
>>> trigger = supriya.ugens.Impulse.kr(frequency=1)
>>> running_max = supriya.ugens.RunningMax.ar(
...     source=source,
...     trigger=0,
... )
>>> running_max
<RunningMax.ar()[0]>
classmethod ar(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
classmethod kr(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
property source : UGenScalar
property trigger : UGenScalar
class RunningMin(*, calculation_rate: CalculationRate | SupportsInt | str | None, source: SupportsFloat | UGenScalar, trigger: SupportsFloat | UGenScalar = 0, **kwargs)

Bases: UGen

Tracks minimum signal amplitude.

>>> source = supriya.ugens.In.ar(bus=0)
>>> trigger = supriya.ugens.Impulse.kr(frequency=1)
>>> running_min = supriya.ugens.RunningMin.ar(
...     source=source,
...     trigger=trigger,
... )
>>> running_min
<RunningMin.ar()[0]>
classmethod ar(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
classmethod kr(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
property source : UGenScalar
property trigger : UGenScalar
class Schmidt(*, calculation_rate: CalculationRate | SupportsInt | str | None, source: SupportsFloat | UGenScalar, minimum: SupportsFloat | UGenScalar = 0.0, maximum: SupportsFloat | UGenScalar = 1.0, **kwargs)

Bases: UGen

A Schmidt trigger.

>>> source = supriya.ugens.SinOsc.ar()
>>> schmidt = supriya.ugens.Schmidt.ar(
...     maximum=0.9,
...     minimum=0.1,
...     source=source,
... )
>>> schmidt
<Schmidt.ar()[0]>
classmethod ar(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], minimum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, maximum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
classmethod kr(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], minimum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, maximum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
property maximum : UGenScalar
property minimum : UGenScalar
property source : UGenScalar
class SendPeakRMS(*, calculation_rate: CalculationRate | SupportsInt | str | None, reply_rate: SupportsFloat | UGenScalar = 20, peak_lag: SupportsFloat | UGenScalar = 3, reply_id: SupportsFloat | UGenScalar = -1, source_size: SupportsFloat | UGenScalar, source: UGenSerializable | Sequence[SupportsFloat | UGenScalar], character_count: SupportsFloat | UGenScalar, character: UGenSerializable | Sequence[SupportsFloat | UGenScalar], **kwargs)

Bases: UGen

Tracks peak and power of a signal for GUI applications.

>>> send_peak_rms = supriya.ugens.SendPeakRMS.kr(
...     command_name="/reply",
...     peak_lag=3,
...     reply_id=-1,
...     reply_rate=20,
...     source=[1, 2, 3],
... )
>>> send_peak_rms
<SendPeakRMS.kr()>
classmethod ar(command_name='/reply', peak_lag=3, reply_id=-1, reply_rate=20, source=None)

Constructs an audio-rate SendPeakRMS.

>>> source = supriya.ugens.In.ar(channel_count=4)
>>> send_peak_rms = supriya.ugens.SendPeakRMS.ar(
...     command_name="/reply",
...     peak_lag=3,
...     reply_id=-1,
...     reply_rate=20,
...     source=source,
... )
>>> send_peak_rms
<SendPeakRMS.ar()>

Returns ugen graph.

classmethod kr(command_name='/reply', peak_lag=3, reply_id=-1, reply_rate=20, source=None)

Constructs a control-rate SendPeakRMS.

>>> source = supriya.ugens.In.ar(channel_count=4)
>>> send_peak_rms = supriya.ugens.SendPeakRMS.kr(
...     command_name="/reply",
...     peak_lag=3,
...     reply_id=-1,
...     reply_rate=20,
...     source=source,
... )
>>> send_peak_rms
<SendPeakRMS.kr()>

Returns ugen graph.

property character : UGenVector
property character_count : UGenScalar
property peak_lag : UGenScalar
property reply_id : UGenScalar
property reply_rate : UGenScalar
property source : UGenVector
property source_size : UGenScalar
class SendReply(*, calculation_rate: CalculationRate | SupportsInt | str | None, trigger: SupportsFloat | UGenScalar, reply_id: SupportsFloat | UGenScalar = -1, character_count: SupportsFloat | UGenScalar, character: UGenSerializable | Sequence[SupportsFloat | UGenScalar], source: UGenSerializable | Sequence[SupportsFloat | UGenScalar], **kwargs)

Bases: UGen

Sends an array of values from the server to all notified clients.

>>> source = supriya.ugens.In.ar(channel_count=4)
>>> trigger = supriya.ugens.Impulse.kr(frequency=1)
>>> send_reply = supriya.ugens.SendReply.kr(
...     command_name="/reply",
...     source=source,
...     trigger=trigger,
... )
classmethod ar(command_name='/reply', reply_id=-1, source=None, trigger=None)

Constructs an audio-rate SendReply.

>>> source = supriya.ugens.In.ar(channel_count=4)
>>> trigger = supriya.ugens.Impulse.kr(frequency=1)
>>> send_reply = supriya.ugens.SendReply.ar(
...     command_name="/reply",
...     source=source,
...     trigger=trigger,
... )
>>> send_reply
<SendReply.ar()>

Returns ugen graph.

classmethod kr(command_name='/reply', reply_id=-1, source=None, trigger=None)

Constructs a control-rate SendReply.

>>> source = supriya.ugens.In.ar(channel_count=4)
>>> trigger = supriya.ugens.Impulse.kr(frequency=1)
>>> send_reply = supriya.ugens.SendReply.kr(
...     command_name="/reply",
...     source=source,
...     trigger=trigger,
... )
>>> send_reply
<SendReply.kr()>

Returns ugen graph.

property character : UGenVector
property character_count : UGenScalar
property reply_id : UGenScalar
property source : UGenVector
property trigger : UGenScalar
class SendTrig(*, calculation_rate: CalculationRate | SupportsInt | str | None, trigger: SupportsFloat | UGenScalar, id_: SupportsFloat | UGenScalar = 0, value: SupportsFloat | UGenScalar = 0.0, **kwargs)

Bases: UGen

classmethod ar(*, trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], id_: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, value: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0) → UGenOperable
classmethod kr(*, trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], id_: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, value: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0) → UGenOperable
property id_ : UGenScalar
property trigger : UGenScalar
property value : UGenScalar
class Sweep(*, calculation_rate: CalculationRate | SupportsInt | str | None, trigger: SupportsFloat | UGenScalar = 0, rate: SupportsFloat | UGenScalar = 1.0, **kwargs)

Bases: UGen

A triggered linear ramp.

>>> sweep = supriya.ugens.Sweep.ar(
...     rate=1,
...     trigger=0,
... )
>>> sweep
<Sweep.ar()[0]>
classmethod ar(*, trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, rate: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
classmethod kr(*, trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, rate: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
property rate : UGenScalar
property trigger : UGenScalar
class TDelay(*, calculation_rate: CalculationRate | SupportsInt | str | None, source: SupportsFloat | UGenScalar, duration: SupportsFloat | UGenScalar = 0.1, **kwargs)

Bases: UGen

A trigger delay.

>>> source = supriya.ugens.Dust.kr(density=1)
>>> tdelay = supriya.ugens.TDelay.ar(
...     duration=0.1,
...     source=source,
... )
>>> tdelay
<TDelay.ar()[0]>
classmethod ar(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], duration: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.1) → UGenOperable
classmethod kr(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], duration: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.1) → UGenOperable
property duration : UGenScalar
property source : UGenScalar
class ToggleFF(*, calculation_rate: CalculationRate | SupportsInt | str | None, trigger: SupportsFloat | UGenScalar = 0, **kwargs)

Bases: UGen

A toggle flip-flop.

>>> trigger = supriya.ugens.Dust.kr(density=1)
>>> toggle_ff = supriya.ugens.ToggleFF.ar(
...     trigger=trigger,
... )
>>> toggle_ff
<ToggleFF.ar()[0]>
classmethod ar(*, trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
classmethod kr(*, trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable
property trigger : UGenScalar
class Trig(*, calculation_rate: CalculationRate | SupportsInt | str | None, source: SupportsFloat | UGenScalar, duration: SupportsFloat | UGenScalar = 0.1, **kwargs)

Bases: UGen

A timed trigger.

>>> source = supriya.ugens.Dust.kr(density=1)
>>> trig = supriya.ugens.Trig.ar(
...     duration=0.1,
...     source=source,
... )
>>> trig
<Trig.ar()[0]>
classmethod ar(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], duration: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.1) → UGenOperable
classmethod kr(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], duration: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.1) → UGenOperable
property duration : UGenScalar
property source : UGenScalar
class Trig1(*, calculation_rate: CalculationRate | SupportsInt | str | None, source: SupportsFloat | UGenScalar, duration: SupportsFloat | UGenScalar = 0.1, **kwargs)

Bases: UGen

A timed trigger.

>>> source = supriya.ugens.Dust.kr(density=1)
>>> trig_1 = supriya.ugens.Trig1.ar(
...     duration=0.1,
...     source=source,
... )
>>> trig_1
<Trig1.ar()[0]>
classmethod ar(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], duration: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.1) → UGenOperable
classmethod kr(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], duration: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.1) → UGenOperable
property duration : UGenScalar
property source : UGenScalar
class Wrap(*, calculation_rate: CalculationRate | SupportsInt | str | None, source: SupportsFloat | UGenScalar, minimum: SupportsFloat | UGenScalar = 0.0, maximum: SupportsFloat | UGenScalar = 1.0, **kwargs)

Bases: UGen

Wraps a signal outside given thresholds.

>>> source = supriya.ugens.SinOsc.ar()
>>> wrap = supriya.ugens.Wrap.ar(
...     maximum=0.9,
...     minimum=0.1,
...     source=source,
... )
>>> wrap
<Wrap.ar()[0]>
classmethod ar(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], minimum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, maximum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
classmethod ir(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], minimum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, maximum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
classmethod kr(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], minimum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, maximum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0) → UGenOperable
property maximum : UGenScalar
property minimum : UGenScalar
property source : UGenScalar
class ZeroCrossing(*, calculation_rate: CalculationRate | SupportsInt | str | None, source: SupportsFloat | UGenScalar, **kwargs)

Bases: UGen

A zero-crossing frequency follower.

>>> source = supriya.ugens.In.ar(bus=0)
>>> zero_crossing = supriya.ugens.ZeroCrossing.ar(
...     source=source,
... )
>>> zero_crossing
<ZeroCrossing.ar()[0]>
classmethod ar(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]]) → UGenOperable
classmethod kr(*, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]]) → UGenOperable
property source : UGenScalar