ipytone.Players#

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

Bases: AudioNode

Multiple players.

__init__(urls, base_url='', volume=0, mute=False, fade_in=0, fade_out=0, **kwargs)#: Public constructor

Methods

`add`(name, url)	Add a player.
`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.
`get_player`(name)	Get the `Player` object that corresponds to `name`.
`stop_all`([time])	Stop all of the players at the given time.
`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.
`disposed`	Returns True if the node was disposed (i.e., disconnected and web audio node freed for garbage collection).
`fade_in`
`fade_out`
`input`	Returns the input node, or None if this node is a source.
`loaded`	Returns True if all audio buffers are loaded.
`log`	A trait whose value must be an instance of a specified class.
`mute`	Mute source
`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.
`state`	Returns 'started' if any of the players are playing.
`volume`	The volume parameter.

add(name, url)#

Add a player.

Parameters:

key (str) – Buffer name.
url (str or AudioBuffer.) – Buffer file URL (str) or AudioBuffer object.

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.

property state#: Returns ‘started’ if any of the players are playing. Otherwise returns ‘stopped’.

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