ipytone.LFO#

class ipytone.LFO(**kwargs: Any)#

Bases: AudioNode

LFO (Low Frequency Oscillator).

A LFO produces an output signal which can be attached to an audio parameter or signal in order to modulate that parameter with an oscillator.

It may be synced to the transport to start/stop and change when the tempo changes.

__init__(frequency='4n', amplitude=1, min=0, max=1, **kwargs)#: Public constructor

Methods

`chain`(*nodes)	Connect the output of this audio node to the other audio nodes in series.
`connect`(destination[, output_number, ...])	Connect the output of this audio node to the input of another node.
`disconnect`(destination[, output_number, ...])	Disconnect the ouput of this audio node from a connected node.
`dispose`()	Dispose and disconnect this audio node (as well as its input/output).
`fan`(*destinations)	Connect the output of this audio node to the `destinations` audio nodes in parallel.
`start`([time])	Start the LFO.
`stop`([time])	Stop the LFO.
`sync`()	Sync the LFO playback state and frequency to the transport.
`to_destination`()	Convenience method to directly connect the output of this audio node to the main output (speakers) node.
`unsync`()	Unsync the LFO from the transport.

Attributes

`amplitude`	LFO amplitude.
`channel_count`	An int trait.
`channel_count_mode`	An enum whose value must be in a given sequence.
`channel_interpretation`	An enum whose value must be in a given sequence.
`convert`	If True, convert input value in units
`disposed`	Returns True if the node was disposed (i.e., disconnected and web audio node freed for garbage collection).
`frequency`	LFO frequency.
`input`	Returns the input node, or None if this node is a source.
`log`	A trait whose value must be an instance of a specified class.
`max_out`
`min_out`
`name`	A trait for unicode strings.
`number_of_inputs`	Returns the number of input slots for the input node (0 for source nodes).
`number_of_outputs`	Returns the number of output slots for the output node (0 for sink nodes).
`output`	Returns the output node, or None if this node is a sink.
`partials`	See Oscillator.partials
`phase`	Starting position of the LFO's cycle
`type`	LFO oscillator type
`units`	LFO output units

chain(*nodes)#: Connect the output of this audio node to the other audio nodes in series.

connect(destination, output_number=0, input_number=0)#

Connect the output of this audio node to the input of another node.

Parameters:

destination (AudioNode or NativeAudioNode or Param or NativeAudioParam) – The destination node.
output_number (int) – The channel number of the output of this node (default: 0).
input_number (int) – The channel number of the input of the destination node (default: 0).

disconnect(destination, output_number=0, input_number=0)#

Disconnect the ouput of this audio node from a connected node.

Parameters:

destination (AudioNode or NativeAudioNode or Param or NativeAudioParam) – The connected destination node.
output_number (int) – The channel number of the output of this node (default: 0).
input_number (int) – The channel number of the input of the destination node (default: 0).

dispose()#: Dispose and disconnect this audio node (as well as its input/output).

property disposed#: Returns True if the node was disposed (i.e., disconnected and web audio node freed for garbage collection).

fan(*destinations)#: Connect the output of this audio node to the destinations audio nodes in parallel.

property input#: Returns the input node, or None if this node is a source.

property number_of_inputs#: Returns the number of input slots for the input node (0 for source nodes).

property number_of_outputs#: Returns the number of output slots for the output node (0 for sink nodes).

property output#: Returns the output node, or None if this node is a sink.

to_destination()#: Convenience method to directly connect the output of this audio node to the main output (speakers) node.