osc¶

class COsc(calculation_rate=None, buffer_id=None, frequency=440.0, beats=0.5, **kwargs)¶

Bases: UGen

A chorusing wavetable oscillator.

>>> cosc = supriya.ugens.COsc.ar(
...     beats=0.5,
...     buffer_id=23,
...     frequency=440,
... )
>>> cosc
COsc.ar()

classmethod ar(buffer_id: SupportsFloat | UGenMethodMixin | None = None, frequency: SupportsFloat | UGenMethodMixin = 440.0, beats: SupportsFloat | UGenMethodMixin = 0.5) → COsc¶

classmethod kr(buffer_id: SupportsFloat | UGenMethodMixin | None = None, frequency: SupportsFloat | UGenMethodMixin = 440.0, beats: SupportsFloat | UGenMethodMixin = 0.5) → COsc¶

property beats : SupportsFloat | UGenMethodMixin¶

property buffer_id : SupportsFloat | UGenMethodMixin¶

property frequency : SupportsFloat | UGenMethodMixin¶

class DegreeToKey(calculation_rate=None, buffer_id=None, source=None, octave=12, **kwargs)¶

Bases: UGen

A signal-to-modal-pitch converter.`

>>> source = supriya.ugens.In.ar(bus=0)
>>> degree_to_key = supriya.ugens.DegreeToKey.ar(
...     buffer_id=23,
...     octave=12,
...     source=source,
... )
>>> degree_to_key
DegreeToKey.ar()

classmethod ar(buffer_id: SupportsFloat | UGenMethodMixin | None = None, source: SupportsFloat | UGenMethodMixin | None = None, octave: SupportsFloat | UGenMethodMixin = 12) → DegreeToKey¶

classmethod kr(buffer_id: SupportsFloat | UGenMethodMixin | None = None, source: SupportsFloat | UGenMethodMixin | None = None, octave: SupportsFloat | UGenMethodMixin = 12) → DegreeToKey¶

property buffer_id : SupportsFloat | UGenMethodMixin¶

property octave : SupportsFloat | UGenMethodMixin¶

property source : SupportsFloat | UGenMethodMixin¶

class Impulse(calculation_rate=None, frequency=440.0, phase=0.0, **kwargs)¶

Bases: UGen

A non-band-limited single-sample impulse generator unit generator.

>>> supriya.ugens.Impulse.ar()
Impulse.ar()

classmethod ar(frequency: SupportsFloat | UGenMethodMixin = 440.0, phase: SupportsFloat | UGenMethodMixin = 0.0) → Impulse¶

classmethod kr(frequency: SupportsFloat | UGenMethodMixin = 440.0, phase: SupportsFloat | UGenMethodMixin = 0.0) → Impulse¶

property frequency : SupportsFloat | UGenMethodMixin¶

property phase : SupportsFloat | UGenMethodMixin¶

class Index(calculation_rate=None, buffer_id=None, source=None, **kwargs)¶

Bases: UGen

A clipping buffer indexer.

>>> source = supriya.ugens.In.ar(bus=0)
>>> index = supriya.ugens.Index.ar(
...     buffer_id=23,
...     source=source,
... )
>>> index
Index.ar()

classmethod ar(buffer_id: SupportsFloat | UGenMethodMixin | None = None, source: SupportsFloat | UGenMethodMixin | None = None) → Index¶

classmethod kr(buffer_id: SupportsFloat | UGenMethodMixin | None = None, source: SupportsFloat | UGenMethodMixin | None = None) → Index¶

property buffer_id : SupportsFloat | UGenMethodMixin¶

property source : SupportsFloat | UGenMethodMixin¶

class LFCub(calculation_rate=None, frequency=440.0, initial_phase=0.0, **kwargs)¶

Bases: UGen

A sine-like oscillator unit generator.

>>> supriya.ugens.LFCub.ar()
LFCub.ar()

classmethod ar(frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0) → LFCub¶

classmethod kr(frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0) → LFCub¶

property frequency : SupportsFloat | UGenMethodMixin¶

property initial_phase : SupportsFloat | UGenMethodMixin¶

class LFGauss(calculation_rate=None, done_action=0, duration=1, initial_phase=0, loop=1, width=0.1)¶

Bases: UGen

A non-band-limited gaussian function oscillator.

>>> supriya.ugens.LFGauss.ar()
LFGauss.ar()

classmethod ar(duration: SupportsFloat | UGenMethodMixin = 1, width: SupportsFloat | UGenMethodMixin = 0.1, initial_phase: SupportsFloat | UGenMethodMixin = 0, loop: SupportsFloat | UGenMethodMixin = 1, done_action: SupportsFloat | UGenMethodMixin = 0) → LFGauss¶

classmethod kr(duration: SupportsFloat | UGenMethodMixin = 1, width: SupportsFloat | UGenMethodMixin = 0.1, initial_phase: SupportsFloat | UGenMethodMixin = 0, loop: SupportsFloat | UGenMethodMixin = 1, done_action: SupportsFloat | UGenMethodMixin = 0) → LFGauss¶

property done_action : SupportsFloat | UGenMethodMixin¶

property duration : SupportsFloat | UGenMethodMixin¶

property initial_phase : SupportsFloat | UGenMethodMixin¶

property loop : SupportsFloat | UGenMethodMixin¶

property width : SupportsFloat | UGenMethodMixin¶

class LFPar(calculation_rate=None, frequency=440.0, initial_phase=0.0, **kwargs)¶

Bases: UGen

A parabolic oscillator unit generator.

>>> supriya.ugens.LFPar.ar()
LFPar.ar()

classmethod ar(frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0) → LFPar¶

classmethod kr(frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0) → LFPar¶

property frequency : SupportsFloat | UGenMethodMixin¶

property initial_phase : SupportsFloat | UGenMethodMixin¶

class LFPulse(calculation_rate=None, frequency=440.0, initial_phase=0.0, width=0.5, **kwargs)¶

Bases: UGen

A non-band-limited pulse oscillator.

>>> supriya.ugens.LFPulse.ar()
LFPulse.ar()

classmethod ar(frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0, width: SupportsFloat | UGenMethodMixin = 0.5) → LFPulse¶

classmethod kr(frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0, width: SupportsFloat | UGenMethodMixin = 0.5) → LFPulse¶

property frequency : SupportsFloat | UGenMethodMixin¶

property initial_phase : SupportsFloat | UGenMethodMixin¶

property width : SupportsFloat | UGenMethodMixin¶

class LFSaw(calculation_rate=None, frequency=440.0, initial_phase=0.0, **kwargs)¶

Bases: UGen

A non-band-limited sawtooth oscillator unit generator.

>>> supriya.ugens.LFSaw.ar()
LFSaw.ar()

classmethod ar(frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0) → LFSaw¶

classmethod kr(frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0) → LFSaw¶

property frequency : SupportsFloat | UGenMethodMixin¶

property initial_phase : SupportsFloat | UGenMethodMixin¶

class LFTri(calculation_rate=None, frequency=440.0, initial_phase=0.0, **kwargs)¶

Bases: UGen

A non-band-limited triangle oscillator unit generator.

>>> supriya.ugens.LFTri.ar()
LFTri.ar()

classmethod ar(frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0) → LFTri¶

classmethod kr(frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0) → LFTri¶

property frequency : SupportsFloat | UGenMethodMixin¶

property initial_phase : SupportsFloat | UGenMethodMixin¶

class Osc(calculation_rate=None, buffer_id=None, frequency=440.0, initial_phase=0.0, **kwargs)¶

Bases: UGen

An interpolating wavetable oscillator.

classmethod ar(buffer_id: SupportsFloat | UGenMethodMixin | None = None, frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0) → Osc¶

classmethod kr(buffer_id: SupportsFloat | UGenMethodMixin | None = None, frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0) → Osc¶

property buffer_id : SupportsFloat | UGenMethodMixin¶

property frequency : SupportsFloat | UGenMethodMixin¶

property initial_phase : SupportsFloat | UGenMethodMixin¶

class OscN(calculation_rate=None, buffer_id=None, frequency=440.0, initial_phase=0.0, **kwargs)¶

Bases: UGen

A non-interpolating wavetable oscillator.

classmethod ar(buffer_id: SupportsFloat | UGenMethodMixin | None = None, frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0) → OscN¶

classmethod kr(buffer_id: SupportsFloat | UGenMethodMixin | None = None, frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0) → OscN¶

property buffer_id : SupportsFloat | UGenMethodMixin¶

property frequency : SupportsFloat | UGenMethodMixin¶

property initial_phase : SupportsFloat | UGenMethodMixin¶

class Select(calculation_rate=None, selector=None, sources=None, **kwargs)¶

Bases: UGen

A signal selector.

>>> sources = supriya.ugens.In.ar(bus=0, channel_count=8)
>>> selector = supriya.ugens.Phasor.kr() * 8
>>> select = supriya.ugens.Select.ar(
...     sources=sources,
...     selector=selector,
... )
>>> select
Select.ar()

classmethod ar(selector: SupportsFloat | UGenMethodMixin | None = None, sources: SupportsFloat | UGenMethodMixin | None = None) → Select¶

classmethod kr(selector: SupportsFloat | UGenMethodMixin | None = None, sources: SupportsFloat | UGenMethodMixin | None = None) → Select¶

property selector : SupportsFloat | UGenMethodMixin¶

property sources : SupportsFloat | UGenMethodMixin¶

class SinOsc(calculation_rate=None, frequency=440.0, phase=0.0, **kwargs)¶

Bases: UGen

A sinusoid oscillator unit generator.

>>> supriya.ugens.SinOsc.ar()
SinOsc.ar()

>>> print(_)
synthdef:
    name: c9b0ed62d4e0666b74166ff5ec09abe4
    ugens:
    -   SinOsc.ar:
            frequency: 440.0
            phase: 0.0

classmethod ar(frequency: SupportsFloat | UGenMethodMixin = 440.0, phase: SupportsFloat | UGenMethodMixin = 0.0) → SinOsc¶

classmethod kr(frequency: SupportsFloat | UGenMethodMixin = 440.0, phase: SupportsFloat | UGenMethodMixin = 0.0) → SinOsc¶

property frequency : SupportsFloat | UGenMethodMixin¶

property phase : SupportsFloat | UGenMethodMixin¶

class SyncSaw(calculation_rate=None, sync_frequency=440.0, saw_frequency=440.0, **kwargs)¶

Bases: UGen

A sawtooth wave that is hard synched to a fundamental pitch.

>>> sync_saw = supriya.ugens.SyncSaw.ar(
...     saw_frequency=440,
...     sync_frequency=440,
... )
>>> sync_saw
SyncSaw.ar()

classmethod ar(sync_frequency: SupportsFloat | UGenMethodMixin = 440.0, saw_frequency: SupportsFloat | UGenMethodMixin = 440.0) → SyncSaw¶

classmethod kr(sync_frequency: SupportsFloat | UGenMethodMixin = 440.0, saw_frequency: SupportsFloat | UGenMethodMixin = 440.0) → SyncSaw¶

property saw_frequency : SupportsFloat | UGenMethodMixin¶

property sync_frequency : SupportsFloat | UGenMethodMixin¶

class VOsc(calculation_rate=None, buffer_id=None, frequency=440.0, phase=0.0, **kwargs)¶

Bases: UGen

A wavetable lookup oscillator which can be swept smoothly across wavetables.

>>> vosc = supriya.ugens.VOsc.ar(
...     buffer_id=supriya.ugens.MouseX.kr(minimum=0, maximum=7),
...     frequency=440,
...     phase=0,
... )
>>> vosc
VOsc.ar()

classmethod ar(buffer_id: SupportsFloat | UGenMethodMixin | None = None, frequency: SupportsFloat | UGenMethodMixin = 440.0, phase: SupportsFloat | UGenMethodMixin = 0.0) → VOsc¶

classmethod kr(buffer_id: SupportsFloat | UGenMethodMixin | None = None, frequency: SupportsFloat | UGenMethodMixin = 440.0, phase: SupportsFloat | UGenMethodMixin = 0.0) → VOsc¶

property buffer_id : SupportsFloat | UGenMethodMixin¶

property frequency : SupportsFloat | UGenMethodMixin¶

property phase : SupportsFloat | UGenMethodMixin¶

class VOsc3(calculation_rate=None, buffer_id=None, freq_1=110.0, freq_2=220.0, freq_3=440.0, **kwargs)¶

Bases: UGen

A wavetable lookup oscillator which can be swept smoothly across wavetables.

>>> vosc_3 = supriya.ugens.VOsc3.ar(
...     buffer_id=supriya.ugens.MouseX.kr(minimum=0, maximum=7),
...     freq_1=110,
...     freq_2=220,
...     freq_3=440,
... )
>>> vosc_3
VOsc3.ar()

classmethod ar(buffer_id: SupportsFloat | UGenMethodMixin | None = None, freq_1: SupportsFloat | UGenMethodMixin = 110.0, freq_2: SupportsFloat | UGenMethodMixin = 220.0, freq_3: SupportsFloat | UGenMethodMixin = 440.0) → VOsc3¶

classmethod kr(buffer_id: SupportsFloat | UGenMethodMixin | None = None, freq_1: SupportsFloat | UGenMethodMixin = 110.0, freq_2: SupportsFloat | UGenMethodMixin = 220.0, freq_3: SupportsFloat | UGenMethodMixin = 440.0) → VOsc3¶

property buffer_id : SupportsFloat | UGenMethodMixin¶

property freq_1 : SupportsFloat | UGenMethodMixin¶

property freq_2 : SupportsFloat | UGenMethodMixin¶

property freq_3 : SupportsFloat | UGenMethodMixin¶

class VarSaw(calculation_rate=None, frequency=440.0, initial_phase=0.0, width=0.5, **kwargs)¶

Bases: UGen

A sawtooth-triangle oscillator with variable duty.

>>> supriya.ugens.VarSaw.ar()
VarSaw.ar()

classmethod ar(frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0, width: SupportsFloat | UGenMethodMixin = 0.5) → VarSaw¶

classmethod kr(frequency: SupportsFloat | UGenMethodMixin = 440.0, initial_phase: SupportsFloat | UGenMethodMixin = 0.0, width: SupportsFloat | UGenMethodMixin = 0.5) → VarSaw¶

property frequency : SupportsFloat | UGenMethodMixin¶

property initial_phase : SupportsFloat | UGenMethodMixin¶

property width : SupportsFloat | UGenMethodMixin¶

class Vibrato(calculation_rate=None, frequency=440, rate=6, depth=0.02, delay=0, onset=0, rate_variation=0.04, depth_variation=0.1, initial_phase=0, **kwargs)¶

Bases: UGen

Vibrato is a slow frequency modulation.

>>> vibrato = supriya.ugens.Vibrato.ar(
...     delay=0,
...     depth=0.02,
...     depth_variation=0.1,
...     frequency=440,
...     initial_phase=0,
...     onset=0,
...     rate=6,
...     rate_variation=0.04,
... )
>>> vibrato
Vibrato.ar()

classmethod ar(frequency: SupportsFloat | UGenMethodMixin = 440, rate: SupportsFloat | UGenMethodMixin = 6, depth: SupportsFloat | UGenMethodMixin = 0.02, delay: SupportsFloat | UGenMethodMixin = 0, onset: SupportsFloat | UGenMethodMixin = 0, rate_variation: SupportsFloat | UGenMethodMixin = 0.04, depth_variation: SupportsFloat | UGenMethodMixin = 0.1, initial_phase: SupportsFloat | UGenMethodMixin = 0) → Vibrato¶

classmethod kr(frequency: SupportsFloat | UGenMethodMixin = 440, rate: SupportsFloat | UGenMethodMixin = 6, depth: SupportsFloat | UGenMethodMixin = 0.02, delay: SupportsFloat | UGenMethodMixin = 0, onset: SupportsFloat | UGenMethodMixin = 0, rate_variation: SupportsFloat | UGenMethodMixin = 0.04, depth_variation: SupportsFloat | UGenMethodMixin = 0.1, initial_phase: SupportsFloat | UGenMethodMixin = 0) → Vibrato¶

property delay : SupportsFloat | UGenMethodMixin¶

property depth : SupportsFloat | UGenMethodMixin¶

property depth_variation : SupportsFloat | UGenMethodMixin¶

property frequency : SupportsFloat | UGenMethodMixin¶

property initial_phase : SupportsFloat | UGenMethodMixin¶

property onset : SupportsFloat | UGenMethodMixin¶

property rate : SupportsFloat | UGenMethodMixin¶

property rate_variation : SupportsFloat | UGenMethodMixin¶

class WrapIndex(calculation_rate=None, buffer_id=None, source=None, **kwargs)¶

Bases: UGen

A wrapping buffer indexer.

>>> source = supriya.ugens.In.ar(bus=0)
>>> wrap_index = supriya.ugens.WrapIndex.ar(
...     buffer_id=23,
...     source=source,
... )
>>> wrap_index
WrapIndex.ar()

classmethod ar(buffer_id: SupportsFloat | UGenMethodMixin | None = None, source: SupportsFloat | UGenMethodMixin | None = None) → WrapIndex¶

classmethod kr(buffer_id: SupportsFloat | UGenMethodMixin | None = None, source: SupportsFloat | UGenMethodMixin | None = None) → WrapIndex¶

property buffer_id : SupportsFloat | UGenMethodMixin¶

property source : SupportsFloat | UGenMethodMixin¶