ipytone.Tremolo#

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

Bases: StereoEffect

Tremolo effect.

__init__(frequency=10, depth=0.5, type='sine', spread=180, **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 tremolo effect.

stop([time])

Stop the tremolo effect.

to_destination()

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

Attributes

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.

depth

Tremolo depth.

disposed

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

frequency

Tremolo 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.

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.

spread

Tremolo stereo spread (degrees)

type

Tremolo LFO type

wet

The wet signal.

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).

property depth: Param#

Tremolo depth.

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 frequency: Signal#

Tremolo frequency.

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.

spread#

Tremolo stereo spread (degrees)

start(time=None)#

Start the tremolo effect.

If it’s already started, this will stop and restart the source.

stop(time=None)#

Stop the tremolo effect.

to_destination()#

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

type#

Tremolo LFO type

property wet#

The wet signal.

Controls how much of the effected will pass through to the output (1 = 100% effected signal, 0 = 100% dry signal)