bufio¶

class BufRd(*, calculation_rate: CalculationRate | SupportsInt | str | None, channel_count: int = 1, buffer_id: SupportsFloat | UGenScalar, phase: SupportsFloat | UGenScalar = 0.0, loop: SupportsFloat | UGenScalar = 1, interpolation: SupportsFloat | UGenScalar = 2, **kwargs)¶

Bases: UGen

A buffer-reading oscillator.

>>> buffer_id = 23
>>> phase = supriya.ugens.Phasor.ar(
...     rate=supriya.ugens.BufRateScale.kr(buffer_id=buffer_id),
...     start=0,
...     stop=supriya.ugens.BufFrames.kr(buffer_id=buffer_id),
... )
>>> buf_rd = supriya.ugens.BufRd.ar(
...     buffer_id=buffer_id,
...     channel_count=2,
...     interpolation=2,
...     loop=1,
...     phase=phase,
... )
>>> buf_rd
<BufRd.ar()>

classmethod ar(*, buffer_id: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], phase: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, loop: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1, interpolation: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 2, channel_count: int = 1) → UGenOperable¶

classmethod kr(*, buffer_id: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], phase: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, loop: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1, interpolation: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 2, channel_count: int = 1) → UGenOperable¶

property buffer_id : UGenScalar¶

property interpolation : UGenScalar¶

property loop : UGenScalar¶

property phase : UGenScalar¶

class BufWr(*, calculation_rate: CalculationRate | SupportsInt | str | None, buffer_id: SupportsFloat | UGenScalar, phase: SupportsFloat | UGenScalar = 0.0, loop: SupportsFloat | UGenScalar = 1.0, source: UGenSerializable | Sequence[SupportsFloat | UGenScalar], **kwargs)¶

Bases: UGen

A buffer-writing oscillator.

>>> buffer_id = 23
>>> phase = supriya.ugens.Phasor.ar(
...     rate=supriya.ugens.BufRateScale.kr(buffer_id=buffer_id),
...     start=0,
...     stop=supriya.ugens.BufFrames.kr(buffer_id=buffer_id),
... )
>>> source = supriya.ugens.In.ar(bus=0, channel_count=2)
>>> buf_wr = supriya.ugens.BufWr.ar(
...     buffer_id=buffer_id,
...     loop=1,
...     phase=phase,
...     source=source,
... )
>>> buf_wr
<BufWr.ar()[0]>

classmethod ar(*, buffer_id: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], phase: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, loop: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]]) → UGenOperable¶

classmethod kr(*, buffer_id: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], phase: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, loop: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]]) → UGenOperable¶

property buffer_id : UGenScalar¶

property loop : UGenScalar¶

property phase : UGenScalar¶

property source : UGenVector¶

class ClearBuf(*, calculation_rate: CalculationRate | SupportsInt | str | None, buffer_id: SupportsFloat | UGenScalar, **kwargs)¶

Bases: UGen

>>> clear_buf = supriya.ugens.ClearBuf.ir(
...     buffer_id=23,
... )
>>> clear_buf
<ClearBuf.ir()[0]>

classmethod ir(*, buffer_id: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]]) → UGenOperable¶

property buffer_id : UGenScalar¶

class LocalBuf(*, calculation_rate: CalculationRate | SupportsInt | str | None, channel_count: SupportsFloat | UGenScalar = 1, frame_count: SupportsFloat | UGenScalar = 1, **kwargs)¶

Bases: UGen

A synth-local buffer.

>>> from supriya.ugens import FFT, IFFT, LocalBuf, Out, PinkNoise, SynthDefBuilder

>>> local_buf = LocalBuf.ir(
...     channel_count=1,
...     frame_count=1,
... )
>>> local_buf
<LocalBuf.ir()[0]>

LocalBuf creates a MaxLocalBufs UGen implicitly during SynthDef compilation:

>>> with SynthDefBuilder() as builder:
...     local_buf = LocalBuf.ir(frame_count=2048)
...     source = PinkNoise.ar()
...     pv_chain = FFT.kr(
...         buffer_id=local_buf,
...         source=source,
...     )
...     ifft = IFFT.ar(pv_chain=pv_chain)
...     out = Out.ar(bus=0, source=ifft)
... 
>>> synthdef = builder.build()
>>> for ugen in synthdef.ugens:
...     ugen
... 
<MaxLocalBufs.ir()>
<LocalBuf.ir()>
<PinkNoise.ar()>
<FFT.kr()>
<IFFT.ar()>
<Out.ar()>

classmethod ir(*, channel_count: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1, frame_count: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1) → UGenOperable¶

property channel_count : UGenScalar¶

property frame_count : UGenScalar¶

class MaxLocalBufs(*, calculation_rate: CalculationRate | SupportsInt | str | None, maximum: SupportsFloat | UGenScalar = 0, **kwargs)¶

Bases: UGen

Sets the maximum number of local buffers in a synth.

Used internally by LocalBuf.

>>> max_local_bufs = supriya.ugens.MaxLocalBufs.ir(maximum=1)
>>> max_local_bufs
<MaxLocalBufs.ir()[0]>

classmethod ir(*, maximum: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0) → UGenOperable¶

property maximum : UGenScalar¶

class PlayBuf(*, calculation_rate: CalculationRate | SupportsInt | str | None, channel_count: int = 1, buffer_id: SupportsFloat | UGenScalar, rate: SupportsFloat | UGenScalar = 1, trigger: SupportsFloat | UGenScalar = 1, start_position: SupportsFloat | UGenScalar = 0, loop: SupportsFloat | UGenScalar = 0, done_action: SupportsFloat | UGenScalar = 0, **kwargs)¶

Bases: UGen

A sample playback oscillator.

>>> buffer_id = 23
>>> play_buf = supriya.ugens.PlayBuf.ar(
...     buffer_id=buffer_id,
...     channel_count=2,
...     done_action=0,
...     loop=0,
...     rate=1,
...     start_position=0,
...     trigger=1,
... )
>>> play_buf
<PlayBuf.ar()>

classmethod ar(*, buffer_id: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], rate: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1, trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1, start_position: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, loop: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, done_action: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, channel_count: int = 1) → UGenOperable¶

classmethod kr(*, buffer_id: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], rate: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1, trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1, start_position: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, loop: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, done_action: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0, channel_count: int = 1) → UGenOperable¶

property buffer_id : UGenScalar¶

property done_action : UGenScalar¶

property loop : UGenScalar¶

property rate : UGenScalar¶

property start_position : UGenScalar¶

property trigger : UGenScalar¶

class RecordBuf(*, calculation_rate: CalculationRate | SupportsInt | str | None, buffer_id: SupportsFloat | UGenScalar, offset: SupportsFloat | UGenScalar = 0.0, record_level: SupportsFloat | UGenScalar = 1.0, preexisting_level: SupportsFloat | UGenScalar = 0.0, run: SupportsFloat | UGenScalar = 1.0, loop: SupportsFloat | UGenScalar = 1.0, trigger: SupportsFloat | UGenScalar = 1.0, done_action: SupportsFloat | UGenScalar = DoneAction.NOTHING, source: UGenSerializable | Sequence[SupportsFloat | UGenScalar], **kwargs)¶

Bases: UGen

Records or overdubs into a buffer.

>>> buffer_id = 23
>>> source = supriya.ugens.In.ar(bus=0, channel_count=2)
>>> record_buf = supriya.ugens.RecordBuf.ar(
...     buffer_id=buffer_id,
...     done_action=0,
...     loop=1,
...     offset=0,
...     preexisting_level=0,
...     record_level=1,
...     run=1,
...     source=source,
...     trigger=1,
... )
>>> record_buf
<RecordBuf.ar()[0]>

classmethod ar(*, buffer_id: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], offset: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, record_level: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0, preexisting_level: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, run: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0, loop: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0, trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0, done_action: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = DoneAction.NOTHING, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]]) → UGenOperable¶

classmethod kr(*, buffer_id: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], offset: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, record_level: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0, preexisting_level: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 0.0, run: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0, loop: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0, trigger: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = 1.0, done_action: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]] = DoneAction.NOTHING, source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]]) → UGenOperable¶

property buffer_id : UGenScalar¶

property done_action : UGenScalar¶

property loop : UGenScalar¶

property offset : UGenScalar¶

property preexisting_level : UGenScalar¶

property record_level : UGenScalar¶

property run : UGenScalar¶

property source : UGenVector¶

property trigger : UGenScalar¶

class ScopeOut(*, calculation_rate: CalculationRate | SupportsInt | str | None, buffer_id: SupportsFloat | UGenScalar, source: UGenSerializable | Sequence[SupportsFloat | UGenScalar], **kwargs)¶

Bases: UGen

Utility UGen for scope output on remote servers.

>>> source = supriya.ugens.In.ar(bus=0, channel_count=2)
>>> scope_out = supriya.ugens.ScopeOut.ar(
...     source=source,
...     buffer_id=0,
... )
>>> scope_out
<ScopeOut.ar()[0]>

classmethod ar(*, buffer_id: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]]) → UGenOperable¶

classmethod kr(*, buffer_id: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]], source: SupportsFloat | UGenOperable | UGenSerializable | Sequence[SupportsFloat | UGenOperable | UGenSerializable | Sequence[UGenRecursiveInput]]) → UGenOperable¶

property buffer_id : UGenScalar¶

property source : UGenVector¶

class ScopeOut2(*, calculation_rate: ~supriya.enums.CalculationRate | ~typing.SupportsInt | str | None, scope_id: ~typing.SupportsFloat | ~supriya.ugens.core.UGenScalar, max_frames: ~typing.SupportsFloat | ~supriya.ugens.core.UGenScalar = 4096, scope_frames: ~typing.SupportsFloat | ~supriya.ugens.core.UGenScalar = <supriya.typing.Default object>, source: ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[~typing.SupportsFloat | ~supriya.ugens.core.UGenScalar], **kwargs)¶

Bases: UGen

Utility UGen for scope output on local servers.

>>> source = supriya.ugens.In.ar(bus=0, channel_count=2)
>>> scope_out_2 = supriya.ugens.ScopeOut2.ar(
...     source=source,
...     scope_id=0,
...     max_frames=8192,
...     scope_frames=2048,
... )
>>> scope_out_2
<ScopeOut2.ar()[0]>

classmethod ar(*, scope_id: ~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[UGenRecursiveInput]], max_frames: ~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[UGenRecursiveInput]] = 4096, scope_frames: ~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[UGenRecursiveInput]] = <supriya.typing.Default object>, source: ~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[UGenRecursiveInput]]) → UGenOperable¶

classmethod kr(*, scope_id: ~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[UGenRecursiveInput]], max_frames: ~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[UGenRecursiveInput]] = 4096, scope_frames: ~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[UGenRecursiveInput]] = <supriya.typing.Default object>, source: ~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[~typing.SupportsFloat | ~supriya.ugens.core.UGenOperable | ~supriya.ugens.core.UGenSerializable | ~typing.Sequence[UGenRecursiveInput]]) → UGenOperable¶

property max_frames : UGenScalar¶

property scope_frames : UGenScalar¶

property scope_id : UGenScalar¶

property source : UGenVector¶