Internal objects

These objects are mainly used by pyo itself, inside other objects.

Objects in this category

• Dummy : Dummy object used to perform arithmetics on PyoObject.

• InputFader : Audio streams crossfader.

• Mix : Mix audio streams to arbitrary number of streams.

• VarPort : Convert numeric value to PyoObject signal with portamento.

• Stream : Audio stream objects. For internal use only.

Dummy

class Dummy(objs_list)

Dummy object used to perform arithmetics on PyoObject.

The user should never instantiate an object of this class.

Parent

PyoObject

Args

objs_list: list of audio Stream objects

List of Stream objects return by the PyoObject hidden method getBaseObjects().

Note

Multiplication, addition, division and substraction don’t changed the PyoObject on which the operation is performed. A dummy object is created, which is just a copy of the audio Streams of the object, and the operation is applied on the Dummy, leaving the original object unchanged. This lets the user performs multiple different arithmetic operations on an object without conficts. Here, b is a Dummy object with a as its input with a mul attribute of 0.5. attribute:

>>> a = Sine()
>>> b = a * .5
>>> print(a)
<pyo.lib.input.Sine object at 0x11fd610>
>>> print(b)
<pyo.lib._core.Dummy object at 0x11fd710>

>>> s = Server().boot()
>>> s.start()
>>> m = Metro(time=0.25).play()
>>> p = TrigChoice(m, choice=[midiToHz(n) for n in [60,62,65,67,69]])
>>> a = SineLoop(p, feedback=.05, mul=.1).mix(2).out()
>>> b = SineLoop(p*1.253, feedback=.05, mul=.06).mix(2).out()
>>> c = SineLoop(p*1.497, feedback=.05, mul=.03).mix(2).out()

Public Data Attributes:

Inherited from PyoObject

mul	float or PyoObject.
add	float or PyoObject.

Public Methods:

__init__(objs_list)

Inherited from PyoObject

__init__([mul, add])
__add__(x)
__radd__(x)
__iadd__(x)
__sub__(x)
__rsub__(x)
__isub__(x)
__mul__(x)
__rmul__(x)
__imul__(x)
__truediv__(x)
__rtruediv__(x)
__itruediv__(x)
__div__(x)
__rdiv__(x)
__idiv__(x)
__pow__(x)
__rpow__(x)
__mod__(x)
__neg__()
__lt__(x)	Return self<value.
__le__(x)	Return self<=value.
__eq__(x)	Return self==value.
__ne__(x)	Return self!=value.
__gt__(x)	Return self>value.
__ge__(x)	Return self>=value.
__do_comp__(comp, mode[, default])
isPlaying([all])	Returns True if the object is currently playing, otherwise, returns False.
isOutputting([all])	Returns True if the object is outputting.
get([all])	Return the first sample of the current buffer as a float.
play([dur, delay])	Start processing without sending samples to output.
out([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
stop([wait])	Stop processing.
mix([voices])	Mix the object's audio streams into voices streams and return a Mix object.
range(min, max)	Adjust mul and add attributes according to a given range.
setMul(x)	Replace the mul attribute.
setAdd(x)	Replace the add attribute.
setSub(x)	Replace and inverse the add attribute.
setDiv(x)	Replace and inverse the mul attribute.
set(attr, value[, port, callback])	Replace any attribute with portamento.
ctrl([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

__init__()
dump()	Print infos about the current state of the object.
getBaseObjects()	Return a list of Stream objects managed by the instance.
getServer()	Return a reference to the current Server object.
getSamplingRate()	Return the current sampling rate (samples per second), as a float.
getBufferSize()	Return the current buffer size (samples per buffer), as an integer.
allowAutoStart([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
useWaitTimeOnStop()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
addLinkedObject(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
setStopDelay(x)	Set a specific waiting time when calling the stop method on this object.
getStopDelay()	Return the waiting time applied when calling the stop method on this object.
__iter__()
__next__()
next()	Alias for __next__ method.
__getitem__(i)
__setitem__(i, x)
__len__()
__repr__()	Return repr(self).
__dir__()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

_init_play()
_reset_from_set([attr])

Inherited from PyoObjectBase

_autoplay([dur, delay])
_autostop([wait])

---

InputFader

class InputFader(input)

Audio streams crossfader.

Args

input: PyoObject

Input signal.

Note

The setInput method, available to object with input attribute, uses an InputFader object internally to perform crossfade between the old and the new audio input assigned to the object.

>>> s = Server().boot()
>>> s.start()
>>> a = SineLoop([449,450], feedback=0.05, mul=.2)
>>> b = SineLoop([650,651], feedback=0.05, mul=.2)
>>> c = InputFader(a).out()
>>> # to created a crossfade, assign a new audio input:
>>> c.setInput(b, fadetime=5)

Public Data Attributes:

input

PyoObject.

Inherited from PyoObject

mul	float or PyoObject.
add	float or PyoObject.

Public Methods:

__init__(input)
setInput(x[, fadetime])	Replace the input attribute.

Inherited from PyoObject

__init__([mul, add])
__add__(x)
__radd__(x)
__iadd__(x)
__sub__(x)
__rsub__(x)
__isub__(x)
__mul__(x)
__rmul__(x)
__imul__(x)
__truediv__(x)
__rtruediv__(x)
__itruediv__(x)
__div__(x)
__rdiv__(x)
__idiv__(x)
__pow__(x)
__rpow__(x)
__mod__(x)
__neg__()
__lt__(x)	Return self<value.
__le__(x)	Return self<=value.
__eq__(x)	Return self==value.
__ne__(x)	Return self!=value.
__gt__(x)	Return self>value.
__ge__(x)	Return self>=value.
__do_comp__(comp, mode[, default])
isPlaying([all])	Returns True if the object is currently playing, otherwise, returns False.
isOutputting([all])	Returns True if the object is outputting.
get([all])	Return the first sample of the current buffer as a float.
play([dur, delay])	Start processing without sending samples to output.
out([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
stop([wait])	Stop processing.
mix([voices])	Mix the object's audio streams into voices streams and return a Mix object.
range(min, max)	Adjust mul and add attributes according to a given range.
setMul(x)	Replace the mul attribute.
setAdd(x)	Replace the add attribute.
setSub(x)	Replace and inverse the add attribute.
setDiv(x)	Replace and inverse the mul attribute.
set(attr, value[, port, callback])	Replace any attribute with portamento.
ctrl([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

__init__()
dump()	Print infos about the current state of the object.
getBaseObjects()	Return a list of Stream objects managed by the instance.
getServer()	Return a reference to the current Server object.
getSamplingRate()	Return the current sampling rate (samples per second), as a float.
getBufferSize()	Return the current buffer size (samples per buffer), as an integer.
allowAutoStart([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
useWaitTimeOnStop()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
addLinkedObject(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
setStopDelay(x)	Set a specific waiting time when calling the stop method on this object.
getStopDelay()	Return the waiting time applied when calling the stop method on this object.
__iter__()
__next__()
next()	Alias for __next__ method.
__getitem__(i)
__setitem__(i, x)
__len__()
__repr__()	Return repr(self).
__dir__()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

_init_play()
_reset_from_set([attr])

Inherited from PyoObjectBase

_autoplay([dur, delay])
_autostop([wait])

---

setInput(x, fadetime=0.05)

Replace the input attribute.

Args

x: PyoObject

New signal to process.

fadetime: float, optional

Crossfade time between old and new input. Defaults to 0.05.

property input

PyoObject. Input signal.

Mix

class Mix(input, voices=1, mul=1, add=0)

Mix audio streams to arbitrary number of streams.

Mix the object’s audio streams as input argument into voices streams.

Parent

PyoObject

Args

input: PyoObject or list of PyoObjects

Input signal(s) to mix the streams.

voices: int, optional

Number of streams of the Mix object. If more than 1, input object’s streams are alternated and added into Mix object’s streams. Defaults to 1.

Note

The mix method of PyoObject creates and returns a new Mix object with mixed streams of the object that called the method. User don’t have to instantiate this class directly. These two calls are identical:

>>> b = a.mix()
>>> b = Mix(a)

The mul and add arguments are relative to the number of voices, ie. if len(mul) is bigger than voices, last mul values will simply be ignored, even if the number of input streams to mix is higher.

>>> s = Server().boot()
>>> s.start()
>>> a = Sine([random.uniform(400,600) for i in range(50)], mul=.02)
>>> b = Mix(a, voices=2).out()
>>> print(len(a))
50
>>> print(len(b))
2

Public Data Attributes:

Inherited from PyoObject

mul	float or PyoObject.
add	float or PyoObject.

Public Methods:

__init__(input[, voices, mul, add])

Inherited from PyoObject

__init__([mul, add])
__add__(x)
__radd__(x)
__iadd__(x)
__sub__(x)
__rsub__(x)
__isub__(x)
__mul__(x)
__rmul__(x)
__imul__(x)
__truediv__(x)
__rtruediv__(x)
__itruediv__(x)
__div__(x)
__rdiv__(x)
__idiv__(x)
__pow__(x)
__rpow__(x)
__mod__(x)
__neg__()
__lt__(x)	Return self<value.
__le__(x)	Return self<=value.
__eq__(x)	Return self==value.
__ne__(x)	Return self!=value.
__gt__(x)	Return self>value.
__ge__(x)	Return self>=value.
__do_comp__(comp, mode[, default])
isPlaying([all])	Returns True if the object is currently playing, otherwise, returns False.
isOutputting([all])	Returns True if the object is outputting.
get([all])	Return the first sample of the current buffer as a float.
play([dur, delay])	Start processing without sending samples to output.
out([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
stop([wait])	Stop processing.
mix([voices])	Mix the object's audio streams into voices streams and return a Mix object.
range(min, max)	Adjust mul and add attributes according to a given range.
setMul(x)	Replace the mul attribute.
setAdd(x)	Replace the add attribute.
setSub(x)	Replace and inverse the add attribute.
setDiv(x)	Replace and inverse the mul attribute.
set(attr, value[, port, callback])	Replace any attribute with portamento.
ctrl([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

__init__()
dump()	Print infos about the current state of the object.
getBaseObjects()	Return a list of Stream objects managed by the instance.
getServer()	Return a reference to the current Server object.
getSamplingRate()	Return the current sampling rate (samples per second), as a float.
getBufferSize()	Return the current buffer size (samples per buffer), as an integer.
allowAutoStart([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
useWaitTimeOnStop()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
addLinkedObject(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
setStopDelay(x)	Set a specific waiting time when calling the stop method on this object.
getStopDelay()	Return the waiting time applied when calling the stop method on this object.
__iter__()
__next__()
next()	Alias for __next__ method.
__getitem__(i)
__setitem__(i, x)
__len__()
__repr__()	Return repr(self).
__dir__()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

_init_play()
_reset_from_set([attr])

Inherited from PyoObjectBase

_autoplay([dur, delay])
_autostop([wait])

---

VarPort

class VarPort(value, time=0.025, init=0.0, function=None, arg=None, mul=1, add=0)

Convert numeric value to PyoObject signal with portamento.

When value attribute is changed, a smoothed ramp is applied from the current value to the new value. If a callback is provided as function argument, it will be called at the end of the line.

Parent

PyoObject

Args

value: float

Numerical target value to reach as an audio stream.

time: float, optional

Ramp time, in seconds, to reach the new value. Defaults to 0.025.

init: float, optional

Initial value of the internal memory. Defaults to 0.

function: Python callable, optional

If provided, it will be called at the end of the line. Defaults to None.

arg: any Python object, optional

Optional argument sent to the function called at the end of the line. Defaults to None.

Note

The out() method is bypassed. VarPort’s signal can not be sent to audio outs.

>>> s = Server().boot()
>>> s.start()
>>> def callback(arg):
...     print("end of line")
...     print(arg)
...
>>> fr = VarPort(value=500, time=2, init=250, function=callback, arg="YEP!")
>>> a = SineLoop(freq=[fr,fr*1.01], feedback=0.05, mul=.2).out()

Public Data Attributes:

value	float.
time	float.
function	Python callable.

Inherited from PyoObject

mul	float or PyoObject.
add	float or PyoObject.

Public Methods:

__init__(value[, time, init, function, arg, ...])
setValue(x)	Changes the target value of the signal stream.
setTime(x)	Changes the ramp time of the object.
setFunction(x)	Replace the function attribute.

Inherited from PyoObject

__init__([mul, add])
__add__(x)
__radd__(x)
__iadd__(x)
__sub__(x)
__rsub__(x)
__isub__(x)
__mul__(x)
__rmul__(x)
__imul__(x)
__truediv__(x)
__rtruediv__(x)
__itruediv__(x)
__div__(x)
__rdiv__(x)
__idiv__(x)
__pow__(x)
__rpow__(x)
__mod__(x)
__neg__()
__lt__(x)	Return self<value.
__le__(x)	Return self<=value.
__eq__(x)	Return self==value.
__ne__(x)	Return self!=value.
__gt__(x)	Return self>value.
__ge__(x)	Return self>=value.
__do_comp__(comp, mode[, default])
isPlaying([all])	Returns True if the object is currently playing, otherwise, returns False.
isOutputting([all])	Returns True if the object is outputting.
get([all])	Return the first sample of the current buffer as a float.
play([dur, delay])	Start processing without sending samples to output.
out([chnl, inc, dur, delay])	Start processing and send samples to audio output beginning at chnl.
stop([wait])	Stop processing.
mix([voices])	Mix the object's audio streams into voices streams and return a Mix object.
range(min, max)	Adjust mul and add attributes according to a given range.
setMul(x)	Replace the mul attribute.
setAdd(x)	Replace the add attribute.
setSub(x)	Replace and inverse the add attribute.
setDiv(x)	Replace and inverse the mul attribute.
set(attr, value[, port, callback])	Replace any attribute with portamento.
ctrl([map_list, title, wxnoserver])	Opens a sliders window to control the parameters of the object.

Inherited from PyoObjectBase

__init__()
dump()	Print infos about the current state of the object.
getBaseObjects()	Return a list of Stream objects managed by the instance.
getServer()	Return a reference to the current Server object.
getSamplingRate()	Return the current sampling rate (samples per second), as a float.
getBufferSize()	Return the current buffer size (samples per buffer), as an integer.
allowAutoStart([switch])	When autoStartChildren is activated in the Server, call this method with False as argument to stop the propagation of play/out/stop methods to and from this object.
useWaitTimeOnStop()	When autoStartChildren is activated in the Server, call this method to force an object given to the mul attribute of another object to use the wait time from the stop method instead of being stopped immediately.
addLinkedObject(x)	When autoStartChildren is activated in the Server, use this method to explicitly add an object in a dsp chain, which is generally controlled by the last object of the chain.
setStopDelay(x)	Set a specific waiting time when calling the stop method on this object.
getStopDelay()	Return the waiting time applied when calling the stop method on this object.
__iter__()
__next__()
next()	Alias for __next__ method.
__getitem__(i)
__setitem__(i, x)
__len__()
__repr__()	Return repr(self).
__dir__()	Default dir() implementation.

Private Data Attributes:

Inherited from PyoObject

_STREAM_TYPE

Inherited from PyoObjectBase

_STREAM_TYPE

Private Methods:

Inherited from PyoObject

_init_play()
_reset_from_set([attr])

Inherited from PyoObjectBase

_autoplay([dur, delay])
_autostop([wait])

---

setValue(x)

Changes the target value of the signal stream.

Args

x: float

Numerical value to convert.

setTime(x)

Changes the ramp time of the object.

Args

x: float

New ramp time.

setFunction(x)

Replace the function attribute.

Args

x: Python function

new function attribute.

property value

float. Numerical target value.

property time

float. Ramp time.

property function

Python callable. Function to be called.

Stream

class Stream

Audio stream objects. For internal use only.

A Stream object must never be instantiated by the user.

A Stream is a mono buffer of audio samples. It is used to pass audio between objects and the server. A PyoObject can manage many streams if, for example, a list is given to a parameter.

A Sine object with only one stream:

>>> a = Sine(freq=1000)
>>> print(len(a))
1

A Sine object with four streams:

>>> a = Sine(freq=[250,500,750,100])
>>> print(len(a))
4

The first stream of this object contains the samples from the 250Hz waveform. The second stream contains the samples from the 500Hz waveform, and so on.

User can call a specific stream of an object by giving the position of the stream between brackets, beginning at 0. To retrieve only the third stream of our object:

>>> a[2].out()

The method getStreamObject() can be called on a Stream object to retrieve the XXX_base object associated with this Stream. This method can be used by developers who are debugging their programs!