ipytone.Player#

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

Bases: Source

Audio file or buffer player with start, loop, and stop functions.

Parameters:

url_or_buffer (str or AudioBuffer) – Audio file (URL) to load or an audio buffer instance.
**kwargs – Other options.

__init__(url_or_buffer, **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.
`schedule_dlink`(target[, update_interval, ...])	Link a source attribute of this ipytone widget with a target widget attribute.
`schedule_jsdlink`(target[, update_interval, ...])	Link a source attribute of this ipytone widget with a target widget attribute.
`schedule_observe`(handler[, update_interval, ...])	Setup a handler to be called at regular intervals with the updated time / value of this ipytone widget.
`schedule_unobserve`(handler)	Cancel the scheduled updates of the time / value trait associated with the given handler.
`set_loop_points`(loop_start, loop_end)	Set the loop start and end.
`start`([time, offset, duration])	Start the audio source.
`stop`([time])	Stop the audio source.
`sync`()	Sync the source 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 source to the transport.

Attributes

`autostart`	Play as soon as the audio buffer is loaded
`buffer`	The audio buffer
`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 in time
`fade_out`	Fade out time
`input`	Returns the input node, or None if this node is a source.
`loaded`	Returns True if the audio buffer is loaded.
`log`	A trait whose value must be an instance of a specified class.
`loop`	Play the audio buffer in loop
`loop_end`	Loop end position (in seconds)
`loop_start`	Loop start position (in seconds)
`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.
`playback_rate`	Playback speed (normal speed is 1)
`reverse`	True if the buffer is reversed
`volume`	The volume parameter.

autostart#: Play as soon as the audio buffer is loaded

buffer#: The audio buffer

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

fade_in#: Fade in time

fade_out#: Fade out time

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 loaded#: Returns True if the audio buffer is loaded.

loop#: Play the audio buffer in loop

loop_end#: Loop end position (in seconds)

loop_start#: Loop start position (in seconds)

mute#: Mute 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.

playback_rate#: Playback speed (normal speed is 1)

reverse#: True if the buffer is reversed

schedule_dlink(target, update_interval=1, transport=False, name=None)#

Link a source attribute of this ipytone widget with a target widget attribute.

As the source attribute may have a continuously updated value (e.g., the gain of an audio signal, the current value of a parameter, etc.), The target widget attribute is synchronized at a given, finite resolution.

Parameters:

target ((object, str) tuple) – The target widget attribute to link, given as a (widget, attr_name) tuple.
update_interval (float or string, optional) – The interval at which the target attribute is updated in the front-end, in seconds (default: 0.04). If transport=True, any interval accepted by schedule_repeat() is also valid here.
transport (bool, optional) – if True, the target attribute is synced along the ipytone.Transport timeline, i.e., no update happens until the transport starts and updates stop when the transport stops. If False (default), the target attribute update is done with respect to the active audio context.
name (str, optional) – The name of the (source) Tone.js attribute to link. See schedule_observe for more details and for a list of available names.

Returns:

link – A link object that can be used to unlink the widget attributes (using the .unlink() method).

Return type:

ToneDirectionalLink

schedule_jsdlink(target, update_interval=0.08, transport=False, name=None)#

Link a source attribute of this ipytone widget with a target widget attribute.

The link is created in the front-end and does not rely on a roundtrip to the backend.

Parameters:

target ((object, str) tuple) – The target widget attribute to link, given as a (widget, attr_name) tuple.
update_interval (float or string, optional) – The interval at which the target attribute is updated in the front-end, in seconds (default: 0.04). If transport=True, any interval accepted by schedule_repeat() is also valid here.
transport (bool, optional) – if True, the target attribute is synced along the ipytone.Transport timeline, i.e., no update happens until the transport starts and updates stop when the transport stops. If False (default), the target attribute update is done with respect to the active audio context.
name (str, optional) – The name of the (source) Tone.js attribute to link. See schedule_observe for more details and for a list of available names.

Returns:

link – A link object that can be used to unlink the widget attributes (using the .unlink() method).

Return type:

ToneDirectionalLink

schedule_observe(handler, update_interval=1, transport=False, name=None, observe_time=False)#

Setup a handler to be called at regular intervals with the updated time / value of this ipytone widget.

Parameters:

handler (callable) – A callable that is called when the trait value is updated at regular intervals. The signature of the callable is similar to the signature expected by ipywidgets.Widget.observe(). Note that the handler will only apply to the trait given by the name argument here.
update_interval (float or string, optional) – The interval at which the trait is updated in the front-end, in seconds (default: 1). If transport=True, any interval accepted by schedule_repeat() is also valid here.
transport (bool, optional) – if True, the trait update is scheduled along the ipytone.Transport timeline, i.e., the handler is not called until the transport starts and will stop being called when the transport stops. If False (default), the trait update is done with respect to the active audio context.
name (str, optional) –
The name of the Tone.js attribute to observe. Note that it doesn’t necessarily correspond to a trait of this ipytone widget. Instead, it may accept one of the following names (depending the observed ipytone widget, only a few may be supported):
- ”time”: the current time (either transport time or audio context time).
- ”value”: the current value of the Tone.js corresponding instance.
- ”state”: current playback state
- ”progress”: current progress (of an event or transport loop)
- ”position”: current transport position in Bars:Beats:Sixteenths
- ”ticks”: current transport tick position
- ”seconds”: current transport time in seconds
The default name also depends on the observed ipytone widget.
observe_time (bool, optional) – If True, both the (current audio context or transport) time and trait value are passed to the handler as a (time, trait_value) tuple when the trait value is updated (default: False).

schedule_unobserve(handler)#: Cancel the scheduled updates of the time / value trait associated with the given handler.

set_loop_points(loop_start, loop_end)#: Set the loop start and end. Will only loop if loop is set to true.

start(time=None, offset=None, duration=None)#

Start the audio source.

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

stop(time=None)#: Stop the audio source.

sync()#

Sync the source to the transport.

All subsequent calls to start and stop are synced to the transport time instead of the audio context time.

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

unsync()#: Unsync the source to the transport.

property volume: Param#: The volume parameter.